-
-
Notifications
You must be signed in to change notification settings - Fork 261
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
API documentation please (especially for types!) #407
Comments
Hi @dhdaines, I agree with your points. I personally don't like automatically generated docs, but we should definitely put more effort into adding the documentation you mentioned. We'll work on that and close the issue once is done. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi, orama looks considerably better structured and documented than the other JavaScript search engines, but...
Maybe I'm just not, um, searching hard enough, but I can't seem to find any actual API documentation. For starters, what type does
create
return? It would be important to know in order to pass it to a function and get type-checking. Does everybody just rely on their IDE/editor to tell them these things?It would be very nice to have a reference document that tells me what all the options are to the functions, what types they return, etc.
The text was updated successfully, but these errors were encountered: