#7737: Code comment style in the documentation
-----------------------------------+----------------------------------------
Reporter: [EMAIL PROTECTED] | Owner: nobody
Status: new | Milestone:
Component: Documentation | Version: SVN
Keywords: comment style PEP 257 | Stage: Unreviewed
Has_patch: 0 |
-----------------------------------+----------------------------------------
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/
--
Ticket URL: <http://code.djangoproject.com/ticket/7737>
Django Code <http://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 post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
