#27656: Fix comment style according to PEP
------------------------------------------------+------------------------
Reporter: Anton Samarchyan | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
https://www.python.org/dev/peps/pep-0257/
The docstring is a phrase ending in a period. It prescribes the function
or method's effect as a command ("Do this", "Return that"), not as a
description; e.g. don't write "Returns the pathname ...".
It's also mentioned in the django code style.
Example from test/client.py - docstrings from two different functions.
{{{
"""
Send a TRACE request to the server.
"""
"""
Sets the Factory to appear as if it has successfully logged into a site.
"""
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27656>
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 [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.2c0b8afaaba8b4cfaf3b00887fd3b01f%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
