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

Support table on forward/backward compatibility of PyGMT with Python and GMT versions #748

Closed
weiji14 opened this issue Dec 18, 2020 · 1 comment · Fixed by #763
Closed
Labels
documentation Improvements or additions to documentation

Comments

@weiji14
Copy link
Member

weiji14 commented Dec 18, 2020

Description of the desired feature

To be nice to our users and clear up any potential source of confusion on PyGMT's compatibility with GMT, we should have a table or something indicating forward/backward compatibility. It's a bit hard to pick thing out from the changelog at https://www.pygmt.org/latest/changes.html. Something like so, inspired by https://github.com/holoviz/pyviz_comms#compatibility (correct me if I'm wrong):

PyGMT GMT Notes
0.1.0 >= 6.0.0, < 6.1.0? #363, requires GMT modern mode
0.1.1 >= 6.0.0, < 6.1.0?
0.2.0 >= 6.1.1 #577, new earth relief pixel registration default
0.2.1 >= 6.1.1
0.3.0 >= 6.1.1 ?
0.4.0 >= 6.2.0 ?

See thread at #729 (comment)_ for context. Probably should add a column for Python compatibility too, related to issue #690.

Are you willing to help implement and maintain this feature? Discuss first on where to put this, maybe at https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions?

@weiji14 weiji14 added the documentation Improvements or additions to documentation label Dec 18, 2020
@seisman
Copy link
Member

seisman commented Dec 19, 2020

Sounds a great idea, although it makes the README even longer 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants