Opened 58 minutes ago

Last modified 13 minutes ago

#36766 assigned Bug

Reference to package as "module" is confusing

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 (last modified by Bob Kline)

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 models module.

in the Using models section of the documentation.

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. In the tutorial the application 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.

Change History (3)

comment:1 by Bob Kline, 57 minutes ago

Description: modified (diff)

comment:2 by Bob Kline, 14 minutes ago

Description: modified (diff)

comment:3 by Bob Kline, 13 minutes ago

Keywords: models added; tutorial removed
Note: See TracTickets for help on using tickets.
Back to Top