#25263: How closely we should adhere to PEP 257
-------------------------------------+-------------------------------------
Reporter: techdragon | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by techdragon):
* status: closed => new
* resolution: wontfix =>
Comment:
I'm reopening it since I didn't get a chance to comment on the criticism
before it was closed.
It's worth considering that some of the things that PEP 257 recommends are
areas beneficial to the level of documentation in the source code.
Checks D100, D101, D102, and D103 all indicate Modules, Classes and
Methods that have no documentation at all.
Others are mainly about consistency and some of them are definitely of
minimal improvement or possibly even detrimental.
The full list is below.
Missing Docstrings
D100 Missing docstring in public module
D101 Missing docstring in public class
D102 Missing docstring in public method
D103 Missing docstring in public function
Whitespace Issues
D200 One-line docstring should fit on one line with quotes
D201 No blank lines allowed before function docstring
D202 No blank lines allowed after function docstring
D203 1 blank line required before class docstring
D204 1 blank line required after class docstring
D205 1 blank line required between summary line and description
D206 Docstring should be indented with spaces, not tabs
D207 Docstring is under-indented
D208 Docstring is over-indented
D209 Multi-line docstring closing quotes should be on a separate line
D210 No whitespaces allowed surrounding docstring text
Quotes Issues
D300 Use “”“triple double quotes”“”
D301 Use r”“” if any backslashes in a docstring
D302 Use u”“” for Unicode docstrings
Docstring Content Issues
D400 First line should end with a period
D401 First line should be in imperative mood
D402 First line should not be the function’s “signature”
--
Ticket URL: <https://code.djangoproject.com/ticket/25263#comment:5>
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/068.937d3a27bb3de6c2b0f7545b171b2b7c%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
