Skip to content

Commit 09802b0

Browse files
seismanweiji14
andauthored
Document the support policy for optional packages (#3616)
Co-authored-by: Wei Ji <[email protected]>
1 parent 7bf2c81 commit 09802b0

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

README.md

+4-11
Original file line numberDiff line numberDiff line change
@@ -191,14 +191,7 @@ Other official wrappers for GMT:
191191
## Minimum supported versions
192192

193193
PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the
194-
rest of the scientific Python ecosystem, and therefore:
195-
196-
- Support for Python versions be dropped 3 years after their initial release.
197-
- Support for core package dependencies (NumPy, pandas, Xarray) be dropped 2 years after
198-
their initial release.
199-
200-
Similarly, the PyGMT team has decided to discontinue support for GMT versions 3 years
201-
after their initial release.
202-
203-
Please see [Minimum Supported Versions](https://www.pygmt.org/dev/minversions.html) for
204-
the minimum supported versions of GMT, Python and core package dependencies.
194+
rest of the scientific Python ecosystem, and made a few extensions based on the needs of
195+
the project. Please see [Minimum Supported Versions](https://www.pygmt.org/dev/minversions.html)
196+
for the detailed policy and the minimum supported versions of GMT, Python and core
197+
package dependencies.

doc/minversions.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,25 @@ myst:
1818
# Minimum Supported Versions
1919

2020
PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the
21-
rest of the scientific Python ecosystem, and therefore:
21+
rest of the scientific Python ecosystem, and will therefore:
2222

23-
- Support for Python versions be dropped 3 years after their initial release.
24-
- Support for core package dependencies (NumPy, pandas, Xarray) be dropped 2 years after
25-
their initial release.
23+
- Drop support for Python versions 3 years after their initial release.
24+
- Drop support for core package dependencies (NumPy, pandas, Xarray) 2 years after their
25+
initial release.
2626

27-
Similarly, the PyGMT team has decided to discontinue support for GMT versions 3 years
28-
after their initial release.
27+
In addition to the above, the PyGMT team has also decided to:
28+
29+
- Drop support for GMT versions 3 years after their initial release, while ensuring at
30+
least two latest minor versions remain supported.
31+
- Maintain support for [optional dependencies](/ecosystem.md#pygmt-dependencies) for at
32+
least 1 year after their initial release. Users are encouraged to use the most
33+
up-to-date optional dependencies where possible.
34+
35+
:::{note}
36+
The SPEC 0 policy is enforced on a best-effort basis, and the PyGMT team may decide to
37+
drop support for core (and optional) package dependencies earlier than recommended for
38+
compatibility reasons.
39+
:::
2940

3041
| PyGMT Version | GMT | Python | NumPy | pandas | Xarray |
3142
|---|---|---|---|---|---|

0 commit comments

Comments
 (0)