[docs] Reformat docstrings to be auto-generated #6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
avinashshenoy97
requested changes
Oct 13, 2022
|
I've added the header back. Apart from that, are there any other issues you can see? I'm using this library for a research project and will likely add some features to it in order to do my research, so there will probably be more feature-related PRs in the next few days. |
|
Damnit, I didn't mean to push all those changes into this merge. I'll close and reopen in a bit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey!
Dunno if you're accepting PRs, but this is a documentation-only change that basically just uses
///instead of//for docstrings, so that the auto-generated documentation on docs.rs will actually display all the existing documentation.