docs: assert correct file extension reference for wheels & sdists #358
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
A minor documentation fix, this section referred to the wheel as a `.tar.gz` file while it isn't – it is fairly known that it is a `.zip` file. I added the correct file extension for the SDist in the point above it, just for the sake of clarity.
agriyakhetarpal
changed the title
|
Oops, thanks! It's correct on the simple page: cookie/docs/pages/guides/packaging_simple.md Line 185 in 09d78f7 |
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.
Hi, this PR is a minor documentation fix – I was just reading through the section "Including/excluding files in the SDist" in the Classic Packaging guide and this point caught my eye: this section talks about the procedure used to install a package via the invocation of the
pip install .command: it incorrectly refers to the wheel as being a.tar.gzfile while it isn't – it is fairly and commonly known that it is a.zipfile.I have mentioned the correct file extension for the wheel and added a note about the SDist being in a sentence above, correctly reporting so that it can be known that the difference exists. I don't think that the incorrect documentation misguides anyone at this moment, but it's good to be correct considering the veracity of the guide since its inception.