Skip to content

Enhance docstring for frequency plot function added doc string #826#1068

Open
sallykinyua wants to merge 1 commit intomalariagen:masterfrom
sallykinyua:patch-2
Open

Enhance docstring for frequency plot function added doc string #826#1068
sallykinyua wants to merge 1 commit intomalariagen:masterfrom
sallykinyua:patch-2

Conversation

@sallykinyua
Copy link

@sallykinyua sallykinyua commented Mar 7, 2026

Added a complete docstring to plot_frequencies_time_series() in malariagen_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 to plot_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

…agen#826

Added detailed docstring for the plot function, including parameters, return values, and notes on confidence intervals.
@sallykinyua
Copy link
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

@sallykinyua
Copy link
Author

Hi @jwgarber I would like your opinion

@jwgarber
Copy link

jwgarber commented Mar 8, 2026

It looks like this function is using the @doc annotation from the numpydoc_decorator package, it may not be necessary to have both the annotation and the docstring. E.g. here is some of the existing documentation (I assume the @doc annotation generates this.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ag3.plot_frequencies_time_series error bars API

2 participants