Correct typo in docs for [project.scripts]
#1770
Merged
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.
There is a slight (but important) discrepancy between the docs and the actual behavior.
As observed here in this generated script:
We see that the return value from the tool is used as the exit code.
I had my code setup to return
Truein the case of a success andFalsein the case of a failure, thinking that the generated code would simply discard that return value.As such, adding this one line will make it clear what the function should be returning.
📚 Documentation preview 📚: https://python-packaging-user-guide--1770.org.readthedocs.build/en/1770/