-
Notifications
You must be signed in to change notification settings - Fork 224
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
Missing Examples for user facing function #1666
Comments
Thanks for the kind words, glad you found them helpful 😃
Agree that As for
Yes you are correct that most data processing functions don't have examples. The main reason is probably because we don't want to slow down the Docs Build CI which currently takes 15 minutes. Bearing in mind that a data processing gallery example would need to 1) run the data processing and 2) produce a plot, which is quite a lot, but definitely possible (there's a recent one @michaelgrund made at #1598). Action point: I think inline docstring might be the way to go with some of these examples. Upstream GMT has done this (e.g. at https://docs.generic-mapping-tools.org/6.3/basemap.html#examples), so we can probably translate these to PyGMT. The |
I agree with using inline examples. I use the GMT inline examples to demonstrate the syntax for non-plotting modules when writing the tests for module-wrapping. |
@GenericMappingTools/pygmt-maintainers Would it be a good idea to add inline docstring examples (without an associated plot) to all of our module docstrings? That way the page would be a one-stop-shop without needing to go to an example. |
Yes to me, as long as we can skip the inline examples in the CI and locally when needed. |
Description of the desired feature
First of all, the existing examples are really, really nice! They helped me a lot understanding the functionality.
I was however not able to find examples for
pygmt.Figure.psconvert
,pygmt.Figure.grd2cpt
, andpygmt.set_display
.Furthermore many of the processing functions are not show in the examples as far as I can tell.
The text was updated successfully, but these errors were encountered: