Opened 6 years ago

Closed 6 years ago

#7737 closed (fixed)

Code comment style in the documentation

Reported by: msas@… Owned by: nobody
Component: Documentation Version: master
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: UI/UX:


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:

Attachments (0)

Change History (1)

comment:1 Changed 6 years ago by russellm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to fixed
  • Status changed from new to closed

Fixed #7737 -- Corrected a comment in the testing docs to be PEP257 compliant. Thanks to msas@… for the report.

Add Comment

Modify Ticket

Change Properties
<Author field>
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'

E-mail address and user name can be saved in the Preferences.

Note: See TracTickets for help on using tickets.