Changes between Version 1 and Version 6 of Ticket #25263


Ignore:
Timestamp:
Aug 13, 2015, 5:56:12 AM (9 years ago)
Author:
Tim Graham
Comment:

Feel free to raise the idea on the DevelopersMailingList. Personally, I don't think requiring docstrings for everything is needed and I don't care for whitespace around class docstrings.

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #25263 – Description

    v1 v6  
    1 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.
     1Currently 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 [https://pypi.python.org/pypi/pep257 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.
    22
    33It 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
Back to Top