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

Add docstrings to nearest_neighbor_interpolator methods in grids.py #2081

Open
namurphy opened this issue Apr 27, 2023 · 0 comments
Open

Add docstrings to nearest_neighbor_interpolator methods in grids.py #2081

namurphy opened this issue Apr 27, 2023 · 0 comments
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org needs docstring See: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#docstrings for more info plasmapy.plasma Related to the plasmapy.plasma subpackage priority: medium Issues & PRs of moderate urgency and importance

Comments

@namurphy
Copy link
Member

While enabling pydocstyle rules in #2080, I found that there are no docstrings for the nearest_neighbor_interpolator methods in CartesianGrid and NonUniformCartesianGrid in plasmapy/plasma/grids.py. We should add docstrings for these methods, and remove the corresponding # noqa comments which are being added in #2080.

@pheuer — might you have a chance to add these docstrings? Thank you!
@namurphy namurphy added docs PlasmaPy Docs at http://docs.plasmapy.org needs docstring See: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#docstrings for more info plasmapy.plasma Related to the plasmapy.plasma subpackage labels Apr 27, 2023
@namurphy namurphy mentioned this issue Apr 27, 2023
Merged
@namurphy namurphy added the priority: medium Issues & PRs of moderate urgency and importance label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org needs docstring See: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#docstrings for more info plasmapy.plasma Related to the plasmapy.plasma subpackage priority: medium Issues & PRs of moderate urgency and importance
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@namurphy