added missing docstring for a public class method. #12083
Closed
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
Member
|
closing; it appears you are an LLM and not actually a person. |
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
Example: added missing docstring for a public class method.
What does this implement/fix?
Per the feedback on my last PR (thanks, btw!) I wanted to attempt a docstring update based on the desired repository requirements -- specifically public function defs that aren't using @copy_doc or @copy_function_doc_to_method_doc that don't currently have a docstring. I've only made one change to make sure i'm getting this correct before looking for more. Any feedback is welcome!
Note: The method is public, but the class does start with a _ -- This wasn't discussed in the comments of my last PR, so I figured i'd submit anyway, but if you don't want any documentation whatsoever for classes that start with _ (regardless of whether the documented method is public) just let me know and I'm happy to close the PR. thanks!
Additional information
Added docstring to the "write" method in the _RawFidWriter