realpython / realpython/python-guide
Add discussion of namespace packages
Open
Nobody has claimed this yet.
PR Would be Accepted
- Dominant language
- Batchfile
- Stars
- 29.8k
- Forks
- 5.9k
- PR merge metrics
- No merged PRs in 30d
Description
Add discussion of namespace packages (ala http://chimera.labs.oreilly.com/books/1230000000393/ch10.html#namespacepackage).
I think the right place is in https://github.com/kennethreitz/python-guide/blob/master/docs/writing/structure.rst#packages.
Contributor guide
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
Open docs/writing/structure.rst and review the Packages section identified in the issue, along with the linked namespace-package reference. Add a discussion of namespace packages in that section; done means the guide explains the topic clearly and the documentation builds successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100