pypa / pypa/packaging.python.org
Archive vs Distribution fuzzy
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
I feel the discussion in is quite confusing about Source Distributions and Source Archives. They are clearly treated as separate, with a Source Archive coming "prior to creation of a Source Distribution" in the glossary, but the output of build --sdist is a "Source Archive" and everything below is called an archive, with "You should always upload a source archive and provide built archives for the platforms your project is compatible with.".
Is this making a false distinction between a distribution and an archive? All tools (python -m build --sdist and python setup.py sdist) make a source distribution which is in an archive format, and the only non-distributable archive I know of is the one GitHub tends to make from tags, which is not something that needs discussion here.
Originally posted by @henryiii in https://github.com/pypa/packaging.python.org/pull/868#discussion_r604170979
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the glossary definition of “Source Archive” and the sections describing build --sdist, source distributions, and built archives. Trace how these terms are used across the documentation, then resolve whether the distinction is intentional and make the terminology consistent; done means the glossary and affected guidance no longer contradict each other.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100