gh-188: add docstrings to all functions and tidy docs #381
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
Saransh-cpp
reviewed
Nov 5, 2024
There was a problem hiding this comment.
Amazing, thanks @paddyroddy! Quite a lot of efforts in this 🙂
Saransh-cpp
approved these changes
Nov 5, 2024
Co-authored-by: Saransh Chopra <[email protected]>
|
@ntessore can you have a look? |
Open
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.
Closes #188, #369, #375. Have set #358 as upstream as it eases the process.
Adds docstrings to all functions, namely a description for all parameters in the
glasspackage. I don't know the code base well, so would be good for these to be checked that they make sense.I'm also not really familiar with RST so worth checking if any of that can be improved.