-
-
Notifications
You must be signed in to change notification settings - Fork 211
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: clarify usage of version files
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.
- Loading branch information
Showing
2 changed files
with
60 additions
and
40 deletions.
There are no files selected for viewing
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
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