Conversation
The intro bullet on the docs landing page still said 'Reading and writing STAC version 1.0'. Since v1.12.0 (STACVersion.DEFAULT_STAC_VERSION = 1.1.0) PySTAC writes v1.1.0 by default. Use the |stac_version| substitution (already defined in conf.py and used in concepts.rst) so the bullet tracks the supported version automatically. Fixes stac-utils#1513
This branch has not been deployed
This file contains hidden or 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
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.
Related Issue(s):
Description:
What
Update the docs landing-page intro bullet to say PySTAC reads and writes STAC
|stac_version|(currently 1.1.0) instead of the outdated "STAC version 1.0".Why / evidence
docs/index.rstline 8 still reads:Since v1.12.0 the default write version is 1.1.0
(
pystac.version.STACVersion.DEFAULT_STAC_VERSION == "1.1.0", and the 1.12.0release notes state "STAC v1.1.0 is now the default"). Verified in a clean venv:
Change
Replace the hard-coded
1.0with the|stac_version|substitution alreadydefined in
docs/conf.py(rst_epilog) and already used indocs/concepts.rst,so the bullet tracks
DEFAULT_STAC_VERSIONautomatically. Also tightened thenext sentence ("Future versions will read..." -> "PySTAC will read...") since
older-version reading already works today. One file, docs only.
Verified
STACVersion.DEFAULT_STAC_VERSION->1.1.0conf.pyepilog applied produces"Reading and writing STAC version 1.1.0."
|stac_version|is an existing, working substitution (used inconcepts.rst).Fixes #1513