Opened 3 weeks ago

Closed 3 weeks ago

#36766 closed Bug (wontfix)

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: yes 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 (5)

comment:1 by Bob Kline, 3 weeks ago

Description: modified (diff)

comment:2 by Bob Kline, 3 weeks ago

Description: modified (diff)

comment:3 by Bob Kline, 3 weeks ago

Keywords: models added; tutorial removed

comment:4 by Bob Kline, 3 weeks ago

Has patch: set

comment:5 by Jacob Walls, 3 weeks ago

Resolution: wontfix
Status: assignedclosed

Hi Bob, thanks for the ticket. I saw this on forum and was going to reply. I don't think we want to describe the models module as a package, as it's not intended to be distributed by itself.

That sense of "package" as "packaged for distribution" is clarified here:
https://docs.djangoproject.com/en/5.2/intro/reusable-apps/#reusability-matters

Given that startapp doesn't create any package metadata I'm wary of adopting that "package" wording in additional places. In other words, neither the models module nor the app needs to be a package.

Note: See TracTickets for help on using tickets.
Back to Top