Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/20378
  
    So, seems we got:
    
    ```
    First line should end with a period. 293
    Multiline docstring should end with 1 blank line. 279
    Blank line missing after one-line summary. 265
    Return value type should be mentioned. 141
    All modules should have docstrings. 109
    One-liner docstrings should fit on one line with quotes. 91
    First line should be in imperative mood ('Do', not 'Does'). 87
    Exported definitions should have docstrings. 61
    Class docstring should have 1 blank line around them. 35
    Use r\"\"\" if any backslashes in your docstrings. 19
    The entire docstring should be indented same as code. 6
    Exported classes should have docstrings. 1
    No blank line before docstring in definitions. 1
    ```
    
    I think we can take in:
    
    ```
    First line should end with a period. 293
    Multiline docstring should end with 1 blank line. 279
    Blank line missing after one-line summary. 265
    The entire docstring should be indented same as code. 6
    Use \"\"\"triple double quotes\"\"\". 3   # this seems only in heapq3.py 
where we ignore pep8.
    No blank line before docstring in definitions. 1
    ```
    
    Not sure on:
    
    ```
    Exported definitions should have docstrings. 61
    Exported classes should have docstrings. 1
    ```
    
    and take out
    
    ```
    Return value type should be mentioned. 141
    All modules should have docstrings. 109
    One-liner docstrings should fit on one line with quotes. 91
    First line should be in imperative mood ('Do', not 'Does'). 87
    Class docstring should have 1 blank line around them. 35
    Use r\"\"\" if any backslashes in your docstrings. 19
    ```
    
    Also, I think we can take out cloudpickle.py, heapq3.py, shared.py, 
python/docs/conf.py, work/*/*.py, python/.eggs/*` as we do in pep8.


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

Reply via email to