pygmt.grdfilter: Support Pythonic arguments for the distance parameter #4405
+77
−26
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
grdfilter's-Doption is the distance flag indicating the meaning of the grid and the width. It can accept one of p or 0-5, butdistance=4is very confusing. This PR makes it take more readable arguments.The long names come from
https://github.com/GenericMappingTools/gmt/blob/328f373b348747abcb2279456778e7f60567eb49/src/grdfilter.c#L149-L155
Preview: https://pygmt-dev--4405.org.readthedocs.build/en/4405/api/generated/pygmt.grdfilter.html