docstring verbs

[Tim Graham]

The current version of our style guide [1] recommends to use "action verbs" (Checks instead of Check). However this contradicts PEP 257 (Docstring Conventions) [2]. The current code mixes these two forms. Claude advocates to follow the PEP [3]. Anyone care to comment on the historical reason we deviated from it and whether or not we should switch?

[1] https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style

[2] ​https://www.python.org/dev/peps/pep-0257/

[3] https://code.djangoproject.com/ticket/24175

[Ryan Hiebert]

I follow the PEP for at least 3 reasons:

1. The PEP. I like using the Python standards.

2. It matches a (the primary?) widespread convention for commit messages.

3. Imperative verbs tend to also be the shortest of the tenses, so that’s a nice side-effect.

Ryan

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-develop...@googlegroups.com.
To post to this group, send email to django-d...@googlegroups.com.
Visit this group at http://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/a37f3514-1d2e-46b0-b104-c020166b8125%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.