docs: clarify usage of version files #1069
Open
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
I found the current discussion around version files somewhat confusing. When you're reading the usage guide, the second point is telling you to make a version file; strongly implying you should. But in reality, you most likely do not need to bother with keeping a specific version file. Explain more clearly about the implications of this. Under this is a section on using `python -m setuptools_scm --help` which seems like an orphan from the "as a cli" section; move it down there. The runtime section starts by telling you what is strongly discouraged without explaination why. Make it clearer by giving the first example as the most supported thing, which is using standard importlib; then briefly discuss the version file from above, explaining what's in it for a standard Python template, then the strongly discouraged direct import method. In the config doc, update to discuss `importlib` for consistency. Correct some capitalization and other minor formatting bits while we're here.
RonnyPfannschmidt
approved these changes
Aug 23, 2024
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.
I found the current discussion around version files somewhat confusing.
When you're reading the usage guide, the second point is telling you to make a version file; strongly implying you should. But in reality, you most likely do not need to bother with keeping a specific version file. Explain more clearly about the implications of this.
Under this is a section on using
python -m setuptools_scm --helpwhich seems like an orphan from the "as a cli" section; move it down there.The runtime section starts by telling you what is strongly discouraged without explaination why. Make it clearer by giving the first example as the most supported thing, which is using standard importlib; then briefly discuss the version file from above, explaining what's in it for a standard Python template, then the strongly discouraged direct import method.
In the config doc, update to discuss
importlibfor consistency.Correct some capitalization and other minor formatting bits while we're here.