#24175: Style guide, docstring verb and PEP 257
------------------------------------------------+------------------------
Reporter: claudep | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/24175>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.2397ce68ca38b26a1971bba30dafb5cd%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
