From c9c1dd72e286531bd6dfab1f7a0a73c6cb142dcd Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 19 Jan 2024 19:25:36 +0800 Subject: [PATCH] Rename compatibility.rst to minversion.rst --- .github/ISSUE_TEMPLATE/bump_gmt_checklist.md | 2 +- .github/ISSUE_TEMPLATE/release_checklist.md | 4 ++-- README.rst | 2 +- doc/index.rst | 2 +- doc/install.md | 2 +- doc/maintenance.md | 8 ++++---- doc/{compatibility.rst => minversions.rst} | 0 7 files changed, 10 insertions(+), 10 deletions(-) rename doc/{compatibility.rst => minversions.rst} (100%) diff --git a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md index f99d6cc64ef..b87f8fba11b 100644 --- a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md +++ b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md @@ -37,7 +37,7 @@ using the following command: - [ ] Bump the minimum required GMT version (1 PR) - [ ] Update `required_version` in `pygmt/clib/session.py` - [ ] Update `test_get_default` in `pygmt/tests/test_clib.py` - - [ ] Update compatibility table in `doc/compatibility.rst` + - [ ] Update minimum required versions in `doc/minversions.rst` - [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml` - [ ] Remove [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 - [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 12304e5e2bf..1f8a6e7585e 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -31,8 +31,8 @@ assignees: '' - [ ] Update DOI (and url for BibTeX) - [ ] Update version - [ ] Update date released - - [ ] Add the documentation link `doc/compatibility.rst` - - [ ] Add compatibility information `doc/compatibility.rst` + - [ ] Add the documentation link `doc/minversions.rst` + - [ ] Add minimum required vesion information `doc/minversions.rst` - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) **Release**: diff --git a/README.rst b/README.rst index b079e41d03b..39d49b22ce8 100644 --- a/README.rst +++ b/README.rst @@ -268,4 +268,4 @@ alongside the rest of the Scientific Python ecosystem, and therefore supports: minimum the last three minor versions. For the supported GMT versions as well as the minimum required Python and NumPy versions -please see the `Compatibility Table `__. +please see `Minimum Required Versions `__. diff --git a/doc/index.rst b/doc/index.rst index a5c92864e83..4130e5e51b5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -40,7 +40,7 @@ api/index.rst changes.md - Minimum Supported Versions + Minimum Supported Versions .. toctree:: :maxdepth: 2 diff --git a/doc/install.md b/doc/install.md index 635558c7de1..887e971ce55 100644 --- a/doc/install.md +++ b/doc/install.md @@ -90,7 +90,7 @@ PyGMT requires the following libraries to be installed: - [packaging](https://packaging.pypa.io) :::{note} -For the minimum supported versions of the dependencies, please see {doc}`compatibility`. +For the minimum supported versions of the dependencies, please see {doc}`minversions`. ::: The following are optional dependencies: diff --git a/doc/maintenance.md b/doc/maintenance.md index e546d032f7e..20007c272eb 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -220,11 +220,11 @@ publishing the actual release notes at {doc}`changes`. 7. Edit the list of people who contributed to the release, linking to their GitHub accounts. Sort their names by the number of commits made since the last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`). -8. Update `doc/compatibility.rst` with new information on the new release version, - including a vX.Y.Z documentation link, and compatibility with - GMT/Python/NumPy versions. Follow +8. Update `doc/minversions.rst` with new information on the new release version, + including a vX.Y.Z documentation link, and minimum required GMT/Python/NumPy + versions. Follow [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description) - for compatibility updates. + for updates. 9. Refresh citation information. Specifically, the BibTeX in `README.rst` and `CITATION.cff` needs to be updated with any metadata changes, including the DOI, release date, and version information. Please also follow diff --git a/doc/compatibility.rst b/doc/minversions.rst similarity index 100% rename from doc/compatibility.rst rename to doc/minversions.rst