Enhanced docstrings for plotting and visualization functions#38
Conversation
|
Thank you for the docstrings but please remove the examples referencing a different library. |
haileyajohnson
changed the title
Check it as I have updated the latest commit without examples |
haileyajohnson
left a comment
haileyajohnson
left a comment
There was a problem hiding this comment.
Great docstrings, thank you! Would you mind reformatting them to google style to match the rest of the projects? I think it it just changing "Parameters" to "Args" and removing the dashed underline.
I have updated them to google style check for my latest commit...Thank You |
The docstrings for plotting functions previously included example sections that referenced external libraries and interactive code (e.g., matplotlib usage with fig.show()). These examples were removed to keep the documentation clean, consistent, and focused only on parameters and return values. This improves clarity and avoids confusion for users while maintaining a standard NumPy-style docstring format across the module.
Updated all function docstrings in plotting.py to follow Google-style formatting for consistency with the rest of the project.
Removed the previous NumPy-style section headers ("Parameters", "Returns") and replaced them with "Args" and "Returns" blocks.
Also ensured that no external or unrelated library references remain.
haileyajohnson
force-pushed
the
add-plotting-docs
branch
from
2b28520 to
a9b712a
Compare
2 participants
This Pull Request adds enhanced docstrings and usage examples for all plotting/visualization methods in CDIPpy as described in Issue #21.
Changes included:
This makes the documentation clearer and helps users understand how to use the plotting functions effectively.