Enhance docstring for frequency plot function added doc string #826#1068
Open
sallykinyua wants to merge 1 commit intomalariagen:masterfrom
Open
Enhance docstring for frequency plot function added doc string #826#1068sallykinyua wants to merge 1 commit intomalariagen:masterfrom
sallykinyua wants to merge 1 commit intomalariagen:masterfrom
Conversation
…agen#826 Added detailed docstring for the plot function, including parameters, return values, and notes on confidence intervals.
Author
|
Hi @jonbrenas I have fixed the issue on documentation in #826 but after completing i cant find it on the issues. I would also like a review |
Author
|
Hi @jwgarber I would like your opinion |
|
It looks like this function is using the |
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
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.
Added a complete docstring to
plot_frequencies_time_series()inmalariagen_data/anoph/frq_base.py, which previously had no documentation.Issue #826 reported that there was no explanation of what the error bars represent in
plot_frequencies_time_series(). Although the issue is now closed, the docstring was still missing from the codebase. This PR addresses that gap.frq_base.py— added full numpydoc-style docstring toplot_frequencies_time_series()including Parameters, Returns, and a Notes section explaining that error bars represent 95% confidence intervals (Wilson score interval method) where CI data are available, and are absent otherwise.Documentation only — no functional code was changed.
Fixes #826