Opened 5 months ago

Closed 5 months ago

Last modified 5 months ago

#36335 closed Cleanup/optimization (fixed)

Incorrect usage of "i.e." in topics/db/managers

Reported by: Kurt Klein Owned by: David Bogar
Component: Documentation Version: 5.2
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

The text, By default, Django uses an instance of the Model._base_manager manager class when accessing related objects (i.e. choice.question), not ... in the managers documentation contains a minor error: "i.e." means "in other words", but I think what is intended here is "for example", which would be "e.g." (unless every related object in Django is in fact choice.question).

Change History (8)

comment:1 by Kurt Klein, 5 months ago

I'm unfamiliar with making pull requests for the Django project, but if you assign this to me, I'll figure it out and make a PR. ;)

comment:2 by David Sanders, 5 months ago

Owner: set to Kurt Klein
Status: newassigned

Hi Kurt, thanks for the report.

Minor documentation updates like this don't require a ticket as they tend to add extra work for maintainers :) In the future feel free to just go ahead and create a PR, it's fairly simple. 👍

Last edited 5 months ago by David Sanders (previous) (diff)

comment:3 by Tim Graham, 5 months ago

Summary: Minor documentation errorIncorrect usage of "i.e." in topics/db/managers

comment:4 by Natalia Bidart, 5 months ago

Triage Stage: UnreviewedAccepted

Hello Kurt, thanks for taking the time to create this ticket. I'm not a native English speaker and the sentence reads well enough for me, though I consulted an LLM about this (while I'm not a fan of them, I do find them useful when it comes to clarifying language related inquiries). It said:

Yes, i.e. is used correctly in that sentence, though e.g. might be more appropriate depending on intent.
Use i.e. (“id est”) to clarify or restate something precisely.
Use e.g. (“exempli gratia”) to give one or more examples.

I guess this report is indeed about being strictly correct, thus I will accept it, but wanted to mention that the current docs as they stand are not necessarily incorrect.

comment:5 by David Bogar, 5 months ago

Has patch: set
Triage Stage: AcceptedReady for checkin

I agree this should be changed. Provided patch:
https://github.com/django/django/pull/19418

comment:6 by David Bogar, 5 months ago

Owner: changed from Kurt Klein to David Bogar
Triage Stage: Ready for checkinAccepted

comment:7 by GitHub <noreply@…>, 5 months ago

Resolution: fixed
Status: assignedclosed

In 7b394b9:

Fixed #36335 -- Fixed typo in docs/topics/db/managers.txt.

comment:8 by Mariusz Felisiak <felisiak.mariusz@…>, 5 months ago

In c08764c:

[5.2.x] Fixed #36335 -- Fixed typo in docs/topics/db/managers.txt.

Backport of 7b394b9988b986429a4da4e60416e0f08ff649e5 from main

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