Add incols to COMMON_OPTIONS, blockmean, and blockmedian#1300
Merged
Add incols to COMMON_OPTIONS, blockmean, and blockmedian#1300
Conversation
michaelgrund
approved these changes
May 26, 2021
Member
michaelgrund
left a comment
There was a problem hiding this comment.
Looks good to me. It's much better than the description I provided originally for Fig.plot() since it also includes a description for using strings.
Member
Author
|
@michaelgrund, thanks for reviewing. I will put a 'final review call' label up and leave this open for ~12 hours in case other people have recommendations. Hopefully this meshes with #1113 and does not slow down you or Will too much with your PRs. |
5 tasks
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…ingTools#1300) * Add incols to COMMON_OPTIONS in decorators.py * Add incols to blockm.py
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
3 participants
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.
Description of proposed changes
This PR adds
incolstoCOMMON_OPTIONSin decorators.py. The current version includes the full information from the GMT docs, but opinions are welcome if others think that 'Full documentation is at :gmt-docs:gmt.html#the-i-option' would be better than a complete description.I added the alias to the pygmt/src/blockm.py methods to make reviewing easier, so that the description for incols can be reviewed using the vercel preview. I didn't add the common option to any other methods in order to keep the diff small.
Addresses #48.
Relates to #764
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version