Added missing docstrings and added missing param/returns info to existing docstrings. #12079
+289
−23
Conversation
This file contains hidden or 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
freewaydev
requested review from
agramfort,
cbrnr,
dengemann,
drammock and
mscheltienne
as code owners
|
Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴 |
Member
|
Thanks for opening this PR! However, we have tended to intentionally avoid documenting params in private functions lately because they tend to go unmaintained and go out of date quickly, so we instead refer to code comments and the publicly documented parameter information when available. Happy to accept a PR to improve clarity of public functions, though! |
Member
|
(Also it's generally a good idea to open an issue about stuff like this before opening a PR so we can discuss before you put in the work to open a PR) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Reference issue
Added missing docstrings and added missing param/returns info to existing docstrings.
What does this implement/fix?
docstrings fixes for the io/egi classes and function defs.
Additional information
Documentation updates only.