#25263: How closely we should adhere to PEP 257
--------------------------------------+--------------------
Reporter: techdragon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
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'.
--
Ticket URL: <https://code.djangoproject.com/ticket/25263>
Django <https://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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/053.e1f1a62ad497c482e14996fd2b1cfa0e%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
