Skip to content

Commit 30df670

Browse files
Remove disclaimer in README (#1590)
* remove disclaimer; move feedback request to about section * remove redundant mention of forum * add semantic versioning to maintenance.md Co-authored-by: Wei Ji <[email protected]>
1 parent 8ea26d8 commit 30df670

File tree

2 files changed

+2
-19
lines changed

2 files changed

+2
-19
lines changed

README.rst

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,6 @@ or visit the `PyGMT Gallery <https://www.pygmt.org/latest/gallery>`__.
5050
:align: center
5151
:target: https://www.youtube.com/watch?v=SSIGJEe0BIk
5252

53-
54-
Disclaimer
55-
----------
56-
57-
🚨 **This package is still undergoing rapid development.** 🚨
58-
59-
All of the API (functions/classes/interfaces) is subject to change until we reach v1.0.0
60-
as per the `semantic versioning specification <https://semver.org/spec/v2.0.0.html>`__.
61-
There may be non-backward compatible changes as we experiment with new design ideas and
62-
implement new features. **This is not a finished product, use with caution.**
63-
64-
We welcome any feedback and ideas!
65-
Let us know by submitting
66-
`issues on GitHub <https://github.com/GenericMappingTools/pygmt/issues>`__
67-
or by posting on our `Discourse forum <https://forum.generic-mapping-tools.org>`__.
68-
6953
About
7054
-----
7155

@@ -78,7 +62,6 @@ We rely heavily on new features that have been implemented in GMT 6.0. In partic
7862
a new *modern execution mode* that greatly simplifies figure creation. **These features
7963
are not available in the 5.4 version of GMT**.
8064

81-
8265
Project goals
8366
-------------
8467

doc/maintenance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,8 @@ adjusted upward on every major and minor release, but never on a patch release.
177177
## Backwards compatibility and deprecation policy
178178

179179
PyGMT is still undergoing rapid development. All of the API is subject to change
180-
until the v1.0.0 release.
181-
180+
until the v1.0.0 release. Versioning in PyGMT is based on the
181+
[semantic versioning specification](https://semver.org/spec/v2.0.0.html) (e.g. vMAJOR.MINOR.PATCH).
182182
Basic policy for backwards compatibility:
183183

184184
- Any incompatible changes should go through the deprecation process below.

0 commit comments

Comments
 (0)