Skip to content

Commit d794a5d

Browse files
committed
Inkuire docs
1 parent 2fd1c32 commit d794a5d

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed
Loading
-971 KB
Binary file not shown.

scala3/scaladoc.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,24 @@ For more information you can follow this [thread](https://contributors.scala-lan
5454
![](../resources/images/scala3/scaladoc/snippet-compiler2.gif)
5555
![](../resources/images/scala3/scaladoc/snippet-compiler1.gif)
5656

57-
### Type-signature browsing
57+
### Hoogle-like searches (Inkuire)
5858

59-
Haskell programmers are probably familiar with Hoogle - a documentation search engine that allows you browse the docs by signatures rather than symbolic names. Since many Scala developers are also functional programming fans, we decided to add a similar functionality to Scaladoc. The whole tool is based on [Inkuire](https://github.com/VirtusLab/Inkuire), which works with Kotlin and is being currently adapted to Scala 3.
59+
Haskell programmers are probably familiar with Hoogle - a documentation search engine that allows you to find functions by their signatures rather than their symbolic names. Since many Scala developers are also functional programming fans, we decided to add a similar functionality to Scaladoc.
6060

61-
![](../resources/images/scala3/scaladoc/inkuire.gif)
61+
To use this feature simply type the signature of the function You are looking for in scaladoc searchbar. This is how it works:
6262

63-
To be up-to-date with this feature you can follow this [thread](https://contributors.scala-lang.org/t/pre-sip-scaladoc-search-by-type-signature/1604/15).
64-
Note that this feature is in an early stage of development. We still don't support type lambdas, higher-kinded types, and some other Scala features.
63+
![](../resources/images/scala3/scaladoc/inkuire-1.0.0-M2_js_map.gif)
6564

65+
For this feature to work scaladoc uses [Inkuire](https://github.com/VirtusLab/Inkuire) search engine, which was designed to work for Kotlin and is being currently adapted to work for Scala 3.
66+
67+
To be up-to-date with this feature You can follow this [scala contributors thread](https://contributors.scala-lang.org/t/pre-sip-scaladoc-search-by-type-signature/1604/15) or follow [Inkuire](https://github.com/VirtusLab/Inkuire) directly for new releases.
68+
69+
Note that this feature is still in development.
70+
Some features that we are still working on:
71+
- Generating type information (InkuireDB) for Java sources
72+
- More advanced type level constructs like e.g. explicit type bounds and repeated types
73+
- Managing dependencies using scaladoc external mappings
74+
- Optimizations
6675

6776

6877
[scaladoc-docstrings]: https://dotty.epfl.ch/docs/usage/scaladoc/scaladocDocstrings.html

0 commit comments

Comments
 (0)