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

Use TODO comments to track deprecations and workarounds #3722

Merged
merged 6 commits into from
Dec 28, 2024
Merged

Conversation

seisman
Copy link
Member

@seisman seisman commented Dec 26, 2024

Description of proposed changes

See #3705 for context.

A simple grep to find all TODOs:

$ grep '# TODO' **/*.py
pygmt/clib/conversion.py:    # TODO(pandas>=2.2): Remove the workaround for pandas<2.2.
pygmt/clib/session.py:            # TODO(GMT>6.5.0): Remove the workaround for upstream bug in GMT<=6.5.0.
pygmt/clib/session.py:    # TODO(PyGMT>=0.15.0): Remove the deprecated open_virtual_file method.
pygmt/clib/session.py:        # TODO(PyGMT>=0.16.0): Remove the "*args" parameter and related codes.
pygmt/clib/session.py:    # TODO(PyGMT>=0.15.0): Remove the deprecated virtualfile_from_data method.
pygmt/conftest.py:# TODO(NumPy>=2.0): Remove the conftest.py file.
pygmt/datasets/tile_map.py:    # TODO(contextily>=1.5.0): Remove the check for the 'zoom_adjust' parameter.
pygmt/figure.py:        # TODO(GMT>=6.5.0): Remve the workaround for upstream bug in GMT<6.5.0.
pygmt/helpers/tempfile.py:            # TODO(GeoPandas>=1.0): Remove the workaround for GeoPandas < 1.
pygmt/src/ternary.py:    # TODO(GMT>=6.5.0): Remove the patch for upstream bug fixed in GMT 6.5.0.
pygmt/src/timestamp.py:    # TODO(GMT>=6.5.0): Remove the patch for upstream bug fixed in GMT 6.5.0.
pygmt/src/timestamp.py:        # TODO(GMT>=6.5.0): Remove the workaround for the new '+t' modifier.
pygmt/tests/test_accessor.py:# TODO(GMT>=6.5.0): Remove the xfail marker for GMT>=6.5.0.
pygmt/tests/test_clib_to_numpy.py:        # TODO(NumPy>=2.0): Remove the if-else statement after NumPy>=2.0.
pygmt/tests/test_clib_to_numpy.py:    # TODO(pandas>=2.2): Remove the workaround for float16 dtype in pandas<2.2.
pygmt/tests/test_clib_to_numpy.py:    # TODO(pandas>=2.2): Remove the workaround for float16 dtype in pandas<2.2.
pygmt/tests/test_clib_to_numpy.py:                # TODO(pandas>=2.1): Remove the skipif marker for pandas<2.1.
pygmt/tests/test_clib_to_numpy.py:            # TODO(pyarrow>=16): Remove the skipif marker for pyarrow<16.
pygmt/tests/test_clib_virtualfile_from_vectors.py:# TODO(PyGMT>=0.16.0): Remove this test in PyGMT v0.16.0 in which the "*args" parameter
pygmt/tests/test_clib_virtualfile_in.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
pygmt/tests/test_clib_virtualfile_in.py:# TODO(PyGMT>=0.16.0): Remove this test in PyGMT v0.16.0 in which the old usage of
pygmt/tests/test_clib_virtualfiles.py:# TODO(PyGMT>=0.15.0): Remove the test after removing the deprecated open_virtual_file
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_meca.py:# TODO(GMT>=6.5.0): Remove the skipif condition for GMT>=6.5.0.
pygmt/tests/test_meca.py:# TODO(GMT>=6.5.0): Remove the skipif marker for GMT>=6.5.0.
pygmt/tests/test_x2sys_cross.py:# TODO(GMT>=6.5.0): Remove the xfail marker for the upstream bug fixed in GMT 6.5.0.
pygmt/tests/test_x2sys_cross.py:# TODO(GMT>=6.5.0): Remove the xfail marker for the upstream bug fixed in GMT 6.5.0.
pygmt/tests/test_x2sys_cross.py:# TODO(GMT>=6.5.0): Remove the xfail marker for the upstream bug fixed in GMT 6.5.0.
pygmt/tests/test_x2sys_cross.py:# TODO(GMT>=6.5.0): Remove the xfail marker for the upstream bug fixed in GMT 6.5.0.

@seisman seisman added the maintenance Boring but important stuff for the core devs label Dec 26, 2024
@seisman seisman added this to the 0.14.0 milestone Dec 26, 2024
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 27, 2024
@seisman seisman mentioned this pull request Dec 27, 2024
49 tasks
@seisman seisman merged commit d890e91 into main Dec 28, 2024
20 of 21 checks passed
@seisman seisman deleted the refactor/todo branch December 28, 2024 14:10
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 28, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant