Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documenting kwargs #178

Closed
dpanici opened this issue Mar 18, 2022 · 0 comments · Fixed by #245
Closed

Documenting kwargs #178

dpanici opened this issue Mar 18, 2022 · 0 comments · Fixed by #245
Assignees
@MothVine
Labels
documentation Improvements or additions to documentation

Comments

@dpanici
Copy link
Collaborator

dpanici commented Mar 18, 2022

Some of our plotting functions have a large amount of kwargs, we could probably use some more documentation of these. Not completely certain of how these are normally documented but here are some posts to get started, seems like we can either add another section under returns, or under parameters (that might work with sphinx)
@f0uriest f0uriest added the documentation Improvements or additions to documentation label May 17, 2022
@dpanici dpanici mentioned this issue Aug 5, 2022
Closed
@dpanici dpanici mentioned this issue Aug 24, 2022
Merged
dpanici added a commit that referenced this issue Sep 8, 2022
@dpanici
Merge pull request #245 from PlasmaControl/plot_kwargs
b154c0d 
Documents kwargs for plotting functions and adds sensible kwargs to those that were lacking them (such as figsize)
 - Document kwargs, according to [matplotlib-style documentation](https://stackoverflow.com/questions/62511086/how-to-document-kwargs-according-to-numpy-style-docstring)
 - add kwargs to plotting functions missing sensible/useful kwargs
 - add check for unused kwargs to most plotting functions
 - add plot comparisons to artifact uploaded to github 
 - bump `pytest-mpl` version to fix [bug](matplotlib/pytest-mpl#171) where if `unittest.TestCase` is used, it did not actually run those tests correctly 

resolves #178 , #244
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MothVine MothVine

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Plot kwargs PlasmaControl/DESC
3 participants
@f0uriest @dpanici @MothVine