spark-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From BryanCutler <...@git.apache.org>
Subject [GitHub] spark issue #20378: [SPARK-11222][Build][Python] Python document style check...
Date Wed, 31 Jan 2018 01:02:45 GMT
Github user BryanCutler commented on the issue:

    https://github.com/apache/spark/pull/20378
  
    I looked at the example output to see see what the errors were.  Specifically looking
at `broadcast.__init__`
    ```
    def __init__(self, sc=None, value=None, pickle_registry=None, path=None):
            """
            Should not be called directly by users -- use L{SparkContext.broadcast()}
            instead.
            """
            if sc is not None:
    ```
    it gave
    ```
    ./python/pyspark/broadcast.py:68:8: First line should end with a period.
    ./python/pyspark/broadcast.py:68:8: Blank line missing after one-line summary.
    ./python/pyspark/broadcast.py:68:8: Multiline docstring should end with 1 blank line.
    ```
    
    I think a lot of docstrings are purposely formatted this way.  What is the format that
it is looking for here?


---

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


Mime
View raw message