#36766: Reference to package as "module" is confusing
-------------------------------+--------------------------------------
Reporter: Bob Kline | Owner: Bob Kline
Type: Bug | Status: assigned
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: tutorial | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------------------------
Description changed by Bob Kline:
Old description:
> Following up on the related [https://forum.djangoproject.com/t/package-
> versus-module/43560 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 `models` module.
>
> in the [https://docs.djangoproject.com/en/5.2/topics/db/models/#using-
> models 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.
New description:
Following up on the related [https://forum.djangoproject.com/t/package-
versus-module/43560 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 `models` module.
in the [https://docs.djangoproject.com/en/5.2/topics/db/models/#using-
models 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 relevant 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.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/36766#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019adf158c5d-7b14c357-4662-43dc-a402-bacc50c677e8-000000%40eu-central-1.amazonses.com.
