- Notifications
You must be signed in to change notification settings - Fork 1k
Inkuire docs#2125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Inkuire docs #2125
Uh oh!
There was an error while loading. Please reload this page.
Conversation
BarkingBad left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look nice, but can we get some user manual either at docs.scala-lang page or at Inkuire README page on example queries etc.
KacperFKorban commented Jul 27, 2021
BarkingBad left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather see most of its content as a separate page under _overviews/scala3-scaladoc/inkuire.md and in scala3/scaladoc.md just quick info and link to the proper doc page.
BarkingBad commented Jul 27, 2021
As it comes to the content of the docs they seem sufficient, but maybe someone not familiar with the Inkuire should review them. Could you @julienrf take a look at whether docs are simple enough to comprehend? |
romanowski left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments but generally this docs strikes a nice balance in terms of length and amount of information provided.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
scala3/scaladoc.md Outdated
| - AndTypes, OrTypes and Functions have to be enclosed in parentheses e.g. `(Int & Any) => String` | ||
| - Transformations without any input can be found by a syntactic by name call e.g. `=> Int` | ||
| - A wildcard `_` can be used to indicate that we want to match any type in a given place e.g. `Long => Double => _` | ||
| - Types in the form of single letter e.g. `A` or a letter with a digit `X1` are automatically assumed to be type variables |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should state here how to look for a type A rather then a type variable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmmm, it's not possible ATM. Created an issue VirtusLab/Inkuire#199
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
julienrf left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for improving the documentation!
I found several typos, though.
Also, I think the structure of the page could be improved. Currently, I see sentences explaining how to use the feature, interleaved with sentences explaining how it works under the hood. Last, I don’t think we should talk about the roadmap here, I would rather put that information in the code repository. Here, we should focus on answering the following questions:
- why is this feature useful?
- how can people use it?
- how can they contribute/help? (answer with a link to the code repository)
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
KacperFKorban commented Jul 27, 2021
@BarkingBad@julienrf Applied requested changes.
Changed the 'intro' a bit to make it more focused on those aspects. Waiting for further feedback 😄 |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
julienrf left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your patience! Could you squash your commits before merging?
KacperFKorban commented Jul 28, 2021
Sure, done |

Update documentation for Hoogle-like searches feature in new scaladoc.