Opened 9 years ago
Last modified 9 years ago
#25263 closed Cleanup/optimization
How closely we should adhere to PEP 257 — at Version 1
| Reported by: | Samuel Bishop | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
Currently the documentation contained in Django's source code has many places where it could be improved, most significantly by having more of it. In order to help discover undocumented code, I ran PEP 257 on the entire project. The thousands of warnings were quite a shock and it was pretty obvious that a pull request for all of the changes would be too large.
It seemed like a good idea to open this ticket and find out if continuing to create new tickets and pull requests for more of this kind of documentation improvement is in line with the overall project code standards. I'm opening a pull request that contains a partial cleanup of the existing documentation inside 'django.views'. https://github.com/django/django/pull/5131