Improve the docs about version_scheme and local_scheme
#1094
Conversation
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
I had a difficult time finding the implementations in the docs, despite knowing of their existence. Adding this cross-reference should help. x
In PEP 440, "local" refers to the optional portion of a version after the `+` <https://peps.python.org/pep-0440/#local-version-identifiers>. But `version_scheme` doesn't apply to this part.
Most people reading this sentence probably don't have PEP 440 memorized.
maresb
changed the title
version_scheme and local_scheme.version_scheme and local_scheme
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I added cross-references to the implementations. it was confusing to me before that the available options weren't listed in
config.md. See comments in individual commits for more details.