Add numpydoc docstring to count_samples()#1187
Open
merezki-11 wants to merge 1 commit intomalariagen:masterfrom
Open
Add numpydoc docstring to count_samples()#1187merezki-11 wants to merge 1 commit intomalariagen:masterfrom
merezki-11 wants to merge 1 commit intomalariagen:masterfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
count_samples()method inanoph/sample_metadata.pyhad nodocstring despite being a public, user-facing API method. This PR adds
a complete numpydoc-style docstring covering the summary, all parameters,
the return value, and three usage examples — consistent with the
documentation style used across the codebase.
Relates to improving documentation coverage for the public API.