I see that
http://docs.djangoproject.com/en/dev/internals/contributing/#coding-style
prefers docstrings like """Calculates something and returns the
result.""" to those like """Calculate something and return the
result.""". That is, it prefers the descriptive form rather than the
imperative.
PEP 257 goes the other way, preferring the imperative. It says the
docstring should prescribe '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 ...".'
Is this difference really intended?
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Django users" group.
To post to this group, send email to django-users@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/django-users?hl=en
-~----------~----~----~----~------~----~------~--~---
