-
Notifications
You must be signed in to change notification settings - Fork 214
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
Comments
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. |
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? |
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. |
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
The text was updated successfully, but these errors were encountered: