Figure.histogram: Let parameter 'extreme' support Pythonic arguments - #4882
Open
seisman wants to merge 2 commits into
Open
Figure.histogram: Let parameter 'extreme' support Pythonic arguments#4882seisman wants to merge 2 commits into
seisman wants to merge 2 commits into
Conversation
37 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR migrates
histogram's-Loption to the new alias system and add support for Pythonic arguments.The GMT CLI syntax is
-Ll|h|b(https://docs.generic-mapping-tools.org/6.7/histogram.html#l), in whichl|h|bare shorthands forlow/high/bothrespectively. The table below summarize the current choices of parameter/argument names in GMT/PyGMT/GMT.jl:l/h/bextremeorout_rangelow/first,high/last,bothextremefirst,last,bothout_rangefirst,last,bothPersonablly, I feel
first/lastare more readable and intuitive thanlow/high. So, this PR usesfirst/last, which is also consistent with GMT.jl.One thing that still differs between GMT.jl and PyGMT is the parameter name. GMT.jl uses
out_range, whilePyGMTusesextreme. I feelout_rangeis more understandable. If we decide to useout_range, then we need to deprecateextremetoout_rangein a few releases.