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.

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

Add inline code examples in plotting module docstrings #1957

Open
5 of 22 tasks
willschlitzer opened this issue Jun 13, 2022 · 3 comments
Open
5 of 22 tasks

Add inline code examples in plotting module docstrings #1957

willschlitzer opened this issue Jun 13, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Helping hands are appreciated longterm Long standing issues that need to be resolved

Comments

@willschlitzer
Copy link
Contributor

willschlitzer commented Jun 13, 2022

As mentioned in this comment, this is a checklist to add inline code examples in the plotting module docstrings.

Are you willing to help implement and maintain this feature? Yes

@willschlitzer willschlitzer added good first issue Good for newcomers documentation Improvements or additions to documentation help wanted Helping hands are appreciated labels Jun 13, 2022
@willschlitzer willschlitzer added this to the 0.8.0 milestone Jun 13, 2022
@willschlitzer willschlitzer self-assigned this Jun 13, 2022
@seisman
Copy link
Member

seisman commented Jun 14, 2022

Hmmm, do we really need to add inline examples for these plotting modules?

Looking at the inset documentation, I think the visual examples at the bottom are more useful than the code example.

@willschlitzer
Copy link
Contributor Author

I thought the general attitude was that inline examples should still be added to plotting modules. My thought it that working code is provided on the function's page without the need to click around to other examples.

@meghanrjones @weiji14 Thoughts?

@weiji14
Copy link
Member

weiji14 commented Jun 14, 2022

The visual examples at the bottom are indeed more useful, but I think it's worth having an example in the docstring as well (e.g. for people working offline). That said, definitely lower on the priority list for now, something for PyGMT v0.8.0 or v0.9.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Helping hands are appreciated longterm Long standing issues that need to be resolved
Projects
None yet
Development

No branches or pull requests

3 participants