docs: recommend _version.py as a nicer default #576
Merged
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
|
Thanks! |
4 tasks
matthewfeickert
added a commit
to scikit-hep/pyhf
that referenced
this pull request
Jun 2, 2021
* Rename generated version file from version.py to _version.py following setuptools_scm recommendations - c.f. pypa/setuptools-scm#576 - Avoids publishing the contents of "version.py" as externally visible API * Amends PR #1450
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.
This renames the recommendation to
_version.py, to avoid publishing the contents of "version.py" as externally visible API. Ideally, one should dofrom ._version import version as __version__to follow common pratice; I could add that as an example if you'd like it. But, regardless, I think this is slightly nicer as a recommendation.Closes #575.