Opened 10 years ago

Closed 10 years ago

#24175 closed Cleanup/optimization (fixed)

Style guide, docstring verb and PEP 257

Reported by: Claude Paroz Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: cmawebsite@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The current version of our style guide is recommending to use action verb (Checks instead of Check). However this contradicts PEP 257 (Docstring Conventions).
https://www.python.org/dev/peps/pep-0257/

The current code is mixing those two forms. I'm not advocating to change all occurrences, but I'd like to see our style guide to match Python recommendations.

Attachments (1)

24175.diff (778 bytes ) - added by Tim Graham 10 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 by Collin Anderson, 10 years ago

Cc: cmawebsite@… added
Triage Stage: UnreviewedAccepted

Sounds like a good idea to me. Seems to me if we change the style guide, we should also change all occurrences. It could be an "easy pickings" ticket.

Accepting based on Tim also agreeing:
https://github.com/django/django/pull/3939/files#r23134983

by Tim Graham, 10 years ago

Attachment: 24175.diff added

comment:2 by Tim Graham, 10 years ago

Has patch: set

comment:3 by Claude Paroz, 10 years ago

Triage Stage: AcceptedReady for checkin

comment:4 by Josh Smeaton, 10 years ago

Do you think it's worth leaving an example in there (flip the good/not-good examples) to give some at-a-glance guidance? The alternative is running off to review the PEP. I don't feel strongly about this though.

comment:5 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: newclosed

In 63412262e54b4814fe115502bebded9c9993b6f7:

Fixed #24175 -- Updated docstring convention.

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