#27963 closed Cleanup/optimization (fixed)
Docstring example in docs doesn't follow PEP 257
Reported by: | Mikkel Munch Mortensen | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.10 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
This is a bit of a pedantic issue with the docs.
This page says "In docstrings, follow PEP 257". Which is then immediately followed by an example that does _not_ follow the PEP 257 convention for one-line docstrings. Is that something that has been discussed a billion times or is it actually a bug?
It caused a somewhat heated discussion on our team today :)
Change History (4)
comment:1 by , 8 years ago
comment:2 by , 8 years ago
Has patch: | set |
---|---|
Summary: | Example in docs doesn't follow PEP 257 in example immediately following the note about following PEP 257 → Docstring example in docs doesn't follow PEP 257 |
Triage Stage: | Unreviewed → Accepted |
Type: | Uncategorized → Cleanup/optimization |
Note:
See TracTickets
for help on using tickets.
I've proposed a fix here: https://github.com/django/django/pull/8216