Update PyPI install instructions and API disclaimer message #421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In anticipation of v0.1.0 release, we're recommending users to just `pip install pygmt` (from PyPI) now instead of installing from Github. Also warning Windows users that using GMT from conda-forge won't work and suggest workarounds.
Tweaking the language of our disclaimer on our main page a bit for v0.1.0. Mention that API is subject to change as per semver, until we reach v1.0.0.
leouieda
approved these changes
Apr 24, 2020
Co-Authored-By: Leonardo Uieda <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
In anticipation of v0.1.0 release, we're recommending users to just
pip install pygmt(from PyPI) now instead of installing from Github.Also warning Windows users that using GMT from conda-forge won't work and suggest workarounds. Plus put a disclaimer that the API (functions and classes) can still change in future releases.
Fixes #
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.