Skip to content

Conversation

@seisman
Copy link
Member

@seisman seisman commented Oct 16, 2025

Use the command grep "# TODO(GMT.*)" **/*.py to find GMT-related workarounds/patches/xfails.

@seisman seisman added this to the 0.18.0 milestone Oct 16, 2025
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Oct 16, 2025
- [ ] Fix failing tests (1 or more PRs)
- [ ] Fix failing doctests reported in the ["Doctest" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)
- [ ] Fix [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass
- [ ] Run `grep "# TODO(GMT.*)" **/*.py` to find TODO items related to GMT
Copy link
Member

Choose a reason for hiding this comment

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

This grep statement doesn't seem to handle leading whitespaces?

Copy link
Member Author

Choose a reason for hiding this comment

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

It works well with leading whitespaces:

$ grep "# TODO(GMT.*)" **/*.py
pygmt/clib/session.py:            # TODO(GMT>6.5.0): Remove the workaround for upstream bug in GMT<=6.5.0.
pygmt/src/plot3d.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"
pygmt/src/plot.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"
pygmt/tests/test_clib_virtualfile_in.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
pygmt/tests/test_datasets_earth_relief.py:# TODO(GMT X.Y.Z): Upstream bug which is not fixed yet.
pygmt/tests/test_grdimage.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.

Copy link
Member

Choose a reason for hiding this comment

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

Hmm, it doesn't seem to work for me on my bash shell in Linux. But usually I just use my IDE's 'Find in Project' anyway.

Copy link
Member Author

Choose a reason for hiding this comment

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

You're right, **/*.py doesn't work well for Bash (I'm using zsh).

Maybe we should use the following command. Also note that we may have TODO comments in

$ grep -r "# TODO(GMT.*)" --include="*.py" .
./pygmt/clib/session.py:            # TODO(GMT>6.5.0): Remove the workaround for upstream bug in GMT<=6.5.0.
./pygmt/tests/test_datasets_earth_relief.py:# TODO(GMT X.Y.Z): Upstream bug which is not fixed yet.
./pygmt/tests/test_grdimage.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
./pygmt/tests/test_clib_virtualfile_in.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
./pygmt/src/plot3d.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"
./pygmt/src/plot.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. final review call This PR requires final review and approval from a second reviewer labels Oct 16, 2025
@seisman seisman merged commit 2b77309 into main Oct 16, 2025
9 checks passed
@seisman seisman deleted the template/bump-gmt-checklist branch October 16, 2025 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants