-
Notifications
You must be signed in to change notification settings - Fork 235
Update the issue template for bumping GMT versions #4167
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
Conversation
| - [ ] 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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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"
Co-authored-by: Wei Ji <[email protected]>
Use the command
grep "# TODO(GMT.*)" **/*.pyto find GMT-related workarounds/patches/xfails.