Opened 16 years ago
Closed 16 years ago
#7737 closed (fixed)
Code comment style in the documentation
| Reported by: | Owned by: | nobody | |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | comment style PEP 257 | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
According to PEP 257 comments should be written:
"...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 ...".
But in the code examples in the documentation, this is not follwed.
For exampel in: http://www.djangoproject.com/documentation/testing/
Note:
See TracTickets
for help on using tickets.
Fixed #7737 -- Corrected a comment in the testing docs to be PEP257 compliant. Thanks to msas@… for the report.