Opened 2 hours ago
Last modified 93 minutes ago
#36766 assigned Bug
Reference to package as "module" is confusing — at Initial Version
| Reported by: | Bob Kline | Owned by: | Bob Kline |
|---|---|---|---|
| Component: | Documentation | Version: | 5.2 |
| Severity: | Normal | Keywords: | models |
| Cc: | Bob Kline | Triage Stage: | Unreviewed |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
Following up on the related forum discussion, I propose changing
... add the name of the module that contains your
models.py.
to
... add the name of the package that contains your
modelsmodule.
in the Using models section of the tutorial.
In my experience, most Python programmers are not aware that, technically speaking, a package is a special type of module. This is due principally to the fact that most of the language in the Python documentation implies that the term "modules" does not include packages. Earlier in the tutorial this package is referred to as a "package," not a "module," and there is no reason not to use the more specific term here, preventing unnecessary confusion.
I will submit a PR shortly.