Skip to content
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

Fix common options in blockm, surface, histogram, rose, and grdtrack #1519

Merged
merged 14 commits into from
Sep 19, 2021

Conversation

maxrjones
Copy link
Member

@maxrjones maxrjones commented Sep 17, 2021

Description of proposed changes

This PR fixes some erroneous additions from #1445 and prior PRs based on fixes made to GMT in GenericMappingTools/gmt#5759. Here is the detailed list:
- skiprows no longer in blockmean, blockmedian, blockmode, surface (not supported)
- gap no longer in histogram, rose (not supported)
- aspatial now documented in grdtrack
- incols now documented in histogram

Closes #1445

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman
Copy link
Member

seisman commented Sep 18, 2021

I feel it's better to split the changes into two separate PRs.

@maxrjones maxrjones changed the title Support 1d array for outcols in grdtrack, blockm and fix erroneous common option documentation Fix erroneous common options Sep 19, 2021
@maxrjones maxrjones changed the title Fix erroneous common options Fix common options in blockm, surface, histogram, rose, and grdtrack Sep 19, 2021
@seisman seisman added this to the 0.5.0 milestone Sep 19, 2021
Co-authored-by: Dongdong Tian <seisman@users.noreply.github.com>
@seisman seisman added final review call This PR requires final review and approval from a second reviewer bug Something isn't working skip-changelog Skip adding Pull Request to changelog labels Sep 19, 2021
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@maxrjones maxrjones removed the final review call This PR requires final review and approval from a second reviewer label Sep 19, 2021
@maxrjones maxrjones merged commit 5fc9680 into main Sep 19, 2021
@maxrjones maxrjones deleted the update-common-strings branch September 19, 2021 20:30
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…enericMappingTools#1519)

* Remove -g gap from histogram, rose

* Add -i incols to histogram

* Remove -s skiprows from blockm.py, surface

* Add -a aspatial to grdtrack

Co-authored-by: Dongdong Tian <seisman@users.noreply.github.com>

Co-authored-by: Dongdong Tian <seisman@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ESWN: Add common options to PyGMT functions and methods
3 participants