-
Notifications
You must be signed in to change notification settings - Fork 96
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
Add API documentation #147
Conversation
I think examples that meant to run in repl can be formatted like this
|
Oh! thnx for the tip |
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.
Rohit, thank you so much for the newly add docstrings to hash.jl and dtm.jl.
I feel that some changes could be made for the newly added docs to dtm.jl, hash.jl . (Refer - https://docs.julialang.org/en/v1/manual/documentation/index.html )
Also, I feel that a separate argument list explanation shouldn't be necessary for each function. (See Point 4. in the link above).
Adding DocStrings to the remaining files done in #150 . 🎉 |
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 have some changes to suggest based on the official julia documentation -
- Function signature should be written with a four spaced indent.
- The one line docstrings should be imperative form, followed by a blank line and then a 2nd paragraph.
- The first line should end with a fullstop.
- Some places arguments have been provided where it may not be necessary (Refer point 4 in docs).
Update docstring - examples with new show functions
@aviks This PR is complete from my side. Needs reviews from you.. |
Hi @aquatiko this looks good, but there is unfortunately a conflict. Could you resolve that please? |
Done @aviks |
I have added the documentation from source docs and the original comments mentioned in the file.
Here I have added API docs only for
documents.jl
file. It's a bit long task to do for all the exported functions, I will be adding them gradually.Closes: #146