Opened 6 years ago

Closed 6 years ago

#15743 closed Cleanup/optimization (fixed)

Docstring for db.models.base.Model.__reduce__() has wrong tense

Reported by: jMyles Owned by: jMyles
Component: Database layer (models, ORM) Version: 1.3
Severity: Normal Keywords: docstring
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


Currently reads "Provide pickling support." Compliance with coding guidelines requires "Provides pickling support."

Attachments (1)

base_docstring_grammer.txt (640 bytes) - added by jMyles 6 years ago.

Download all attachments as: .zip

Change History (8)

Changed 6 years ago by jMyles

Attachment: base_docstring_grammer.txt added

comment:1 Changed 6 years ago by jMyles

Needs documentation: unset
Needs tests: unset
Owner: changed from nobody to jMyles
Patch needs improvement: unset
Status: newassigned

comment:2 Changed 6 years ago by jMyles

Resolution: fixed
Status: assignedclosed

comment:3 Changed 6 years ago by jMyles

Resolution: fixed
Status: closedreopened

comment:4 Changed 6 years ago by jMyles

Status: reopenednew

Looking back, it looks like I did a few things wrong with this ticket - still getting the hang of the social convention here.

*I didn't name the patch .diff
*I marked it fixed, which is supposed to be an action taken by the core team once the patch is rolled in (I have since marked it 're-opened'

Have I done everything else properly?

comment:5 Changed 6 years ago by Claude Paroz

While grepping through the code, you'll find that both forms are often used. It might be due to the fact that Django coding guidelines in this case are against PEP 257. I'm not sure it's worth fixing. Or update the guidelines?

comment:6 Changed 6 years ago by jMyles

Well, this is an utterly trivial case. I'm not sure what to grep for to determine if non-trivial cases currently exist. There are times when the convention, which is apparently to use the present recurring tense in the indicative mood ("action words") is far more clear than the simple present imperative ("provide spam and eggs to the other classes").

I actually don't really care about the grammar issue all that much; I really just wanted to get my feet wet with opening a ticket and submitting a patch - my hats are, in order: [developer, grammar police]. ;-)

comment:7 Changed 6 years ago by Adrian Holovaty

Resolution: fixed
Status: newclosed

In [16006]:

Fixed #15743 -- Fixed tense in a docstring in db/models/ Thanks, jMyles

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