Add inline code examples in data processing module docstrings #1686

Activity

1. willschlitzer

   added

   questionFurther information is requestedFurther information is requested

   feature requestNew feature wantedNew feature wanted

   on Dec 24, 2021
2. willschlitzer

   self-assigned this

   on Dec 24, 2021
3. maxrjones commented on Jan 20, 2022

   

   maxrjones

   on Jan 20, 2022

   Member

   More actions

   Regarding the CI issue raised in #1666 (comment), here are two options:

   1. Use the doctest skip directive to skip particular examples all the time.
   2. Add a new target to the Makefile to invoke pytest without doctest, such that the tests without docstring examples can be run on every PR and doctests could be run occasionally.
4. willschlitzer

   changed the title [-]Add inline code examples in module docstrings[/-] [+]Add inline code examples in data processing module docstrings[/+] on Jan 28, 2022
5. willschlitzer commented on Jan 28, 2022

   

   willschlitzer

   on Jan 28, 2022

   ContributorAuthor

   More actions

   @GenericMappingTools/pygmt-maintainers Should this only be for data processing modules that can't be as easily demonstrated as a plotting function, or should there be in-line examples for all of our modules?

   My vote is for all of them.
6. maxrjones commented on Jan 28, 2022

   

   maxrjones

   on Jan 28, 2022

   Member

   More actions

   Should this only be for data processing modules that can't be as easily demonstrated as a plotting function, or should there be in-line examples for all of our modules?

   My vote is for all of them.

   Sounds good to me.
7. weiji14 commented on Jan 29, 2022

   

   weiji14

   on Jan 29, 2022

   Member

   More actions

   Should this only be for data processing modules that can't be as easily demonstrated as a plotting function, or should there be in-line examples for all of our modules?

   My vote is for all of them.

   Sounds good to me.

   Ok with doing inline examples for all, but maybe prioritize those that don't already have a gallery example first. E.g. don't do grdgradient until much later.

   👍React with 👍1Reacted by Will Schlitzer
8. weiji14

   added

   good first issueGood for newcomersGood for newcomers

   help wantedHelping hands are appreciatedHelping hands are appreciated

   documentationImprovements or additions to documentationImprovements or additions to documentation

   and removed

   questionFurther information is requestedFurther information is requested

   feature requestNew feature wantedNew feature wanted

   on Feb 4, 2022
9. michaelgrund

   added a commit that references this issue on Feb 13, 2022

   Add inline example for select

   ...

   0404c25
10. seisman

    added this to the 0.6.0 milestone on Feb 16, 2022
11. 10 remaining items

    Load more

12. willschlitzer commented on May 6, 2022

    

    willschlitzer

    on May 6, 2022

    Last edited by willschlitzer

    ContributorAuthor

    More actions

    Are there any gridded datasets with holes in them to use for an example for grdfill? I can use the code from one of the tests, but it seems counterproductive to demo removing data from a grd file only to add it back in with grdfill.
13. maxrjones commented on May 6, 2022

    

    maxrjones

    on May 6, 2022

    Member

    More actions

    Are there any gridded datasets with holes in them to use for an example for grdfill? I can use the code from one of the tests, but it seems counterproductive to demo removing data from a grd file only to add it back in with grdfill.

    Looking through https://oceania.generic-mapping-tools.org/cache/, data_w_nans.nc seems like one option. Below is a picture from the gmt tests that uses that file.

    
14. willschlitzer commented on May 6, 2022

    

    willschlitzer

    on May 6, 2022

    ContributorAuthor

    More actions

    Are there any gridded datasets with holes in them to use for an example for grdfill? I can use the code from one of the tests, but it seems counterproductive to demo removing data from a grd file only to add it back in with grdfill.

    Looking through https://oceania.generic-mapping-tools.org/cache/, data_w_nans.nc seems like one option. Below is a picture from the gmt tests that uses that file.

    

    Thanks @meghanrjones!
15. maxrjones commented on May 6, 2022

    

    maxrjones

    on May 6, 2022

    Member

    More actions

    Are there any gridded datasets with holes in them to use for an example for grdfill? I can use the code from one of the tests, but it seems counterproductive to demo removing data from a grd file only to add it back in with grdfill.

    There's now a better file to use - earth_relief_20m_holes.grd, see GenericMappingTools/gmt#6678 and GenericMappingTools/gmtserver-admin#155 for background.
16. seisman

    modified the milestones: 0.7.0, 0.8.0 on Jun 28, 2022
17. seisman

    unpinned this issue on Dec 2, 2022
18. seisman

    modified the milestones: 0.8.0, 0.9.0 on Dec 11, 2022
19. seisman

    modified the milestones: 0.9.0, 0.10.0 on Mar 19, 2023
20. weiji14

    added

    longtermLong standing issues that need to be resolvedLong standing issues that need to be resolved

    on Aug 24, 2023
21. weiji14

    removed this from the 0.10.0 milestone on Aug 24, 2023
22. weiji14

    removed

    good first issueGood for newcomersGood for newcomers

    on Oct 26, 2026
23. AisunZa commented on Nov 10, 2026

    

    AisunZa

    on Nov 10, 2026

    Contributor

    More actions

    Hi! I'd like to contribute a small documentation improvement for the unchecked filter1d item in this issue.

    My plan is to add a self-contained example demonstrating Gaussian filtering of a simple synthetic time series, limited to `pygmt/src/filter1d.py`.
    
    I'll follow the existing inline-example conventions and validate the example before submitting a PR.
    
    Thanks!