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

Documentation Docstring overhaul #110

Closed
jukent opened this issue Apr 25, 2023 · 1 comment · Fixed by #116
Closed

Documentation Docstring overhaul #110

jukent opened this issue Apr 25, 2023 · 1 comment · Fixed by #116
Assignees
@jukent
Labels
documentation Improvements or additions to documentation

Comments

@jukent
Copy link
Collaborator

jukent commented Apr 25, 2023 •
edited
Loading

Make every viz function doc string link to geocat-examples script that uses it.

Also @anissa111 mentioned a previous docstring overhaul in comp and uxarray. Find relevant PRs and issues to that for guidance. We want consistent docstring formatting across repositories. Several docstrings are rendering weirdly, will fix them all with this overhaul in one push.
@jukent jukent changed the title Link to examples in every viz function Documentation Docstring overhaul Apr 25, 2023
@jukent
Copy link
Collaborator Author

jukent commented Apr 25, 2023

Potential relevant PRs:

NCAR/geocat-comp#260
NCAR/geocat-comp#284

@jukent jukent self-assigned this Apr 26, 2023
@jukent jukent added the documentation Improvements or additions to documentation label Apr 26, 2023
@jukent jukent mentioned this issue Apr 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jukent jukent

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

Successfully merging a pull request may close this issue.

Overhauling Documentation jukent/geocat-viz
1 participant
@jukent