Changes between Initial Version and Version 1 of Ticket #25263, comment 5


Ignore:
Timestamp:
Aug 13, 2015, 12:39:09 AM (9 years ago)
Author:
Samuel Bishop

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #25263, comment 5

    initial v1  
    33
    44Checks D100, D101, D102, and D103 all indicate Modules, Classes and Methods that have no documentation at all.
    5 Others are mainly about consistency and some of them are definitely of minimal improvement or possibly even detrimental.
     5Others are mainly about consistency and some of them are definitely of minimal improvement or possibly even detrimental. D206 overlaps with PEP8
    66
    77The full list is below.
    … …  
    3232D401    First line should be in imperative mood
    3333D402    First line should not be the function’s “signature”
     34
     35In my own mind, this subset feels like its worth adopting.
     36Other than the ones for missing docstrings, most of Django's documentation already fits within these checks.
     37D100 Missing docstring in public module
     38D101 Missing docstring in public class
     39D102 Missing docstring in public method
     40D103 Missing docstring in public function
     41D201 No blank lines allowed before function docstring
     42D202 No blank lines allowed after function docstring
     43D203 1 blank line required before class docstring
     44D204 1 blank line required after class docstring
     45D209 Multi-line docstring closing quotes should be on a separate line
     46D300 Use “”“triple double quotes”“”
     47D401 First line should be in imperative mood
     48D402 First line should not be the function’s “signature”
Back to Top