Skip to content
Snippets Groups Projects
  • hyukjinkwon's avatar
    d228cd0b
    [SPARK-20442][PYTHON][DOCS] Fill up documentations for functions in Column API in PySpark · d228cd0b
    hyukjinkwon authored
    ## What changes were proposed in this pull request?
    
    This PR proposes to fill up the documentation with examples for `bitwiseOR`, `bitwiseAND`, `bitwiseXOR`. `contains`, `asc` and `desc` in `Column` API.
    
    Also, this PR fixes minor typos in the documentation and matches some of the contents between Scala doc and Python doc.
    
    Lastly, this PR suggests to use `spark` rather than `sc` in doc tests in `Column` for Python documentation.
    
    ## How was this patch tested?
    
    Doc tests were added and manually tested with the commands below:
    
    `./python/run-tests.py --module pyspark-sql`
    `./python/run-tests.py --module pyspark-sql --python-executable python3`
    `./dev/lint-python`
    
    Output was checked via `make html` under `./python/docs`. The snapshots will be left on the codes with comments.
    
    Author: hyukjinkwon <gurwls223@gmail.com>
    
    Closes #17737 from HyukjinKwon/SPARK-20442.
    d228cd0b
    History
    [SPARK-20442][PYTHON][DOCS] Fill up documentations for functions in Column API in PySpark
    hyukjinkwon authored
    ## What changes were proposed in this pull request?
    
    This PR proposes to fill up the documentation with examples for `bitwiseOR`, `bitwiseAND`, `bitwiseXOR`. `contains`, `asc` and `desc` in `Column` API.
    
    Also, this PR fixes minor typos in the documentation and matches some of the contents between Scala doc and Python doc.
    
    Lastly, this PR suggests to use `spark` rather than `sc` in doc tests in `Column` for Python documentation.
    
    ## How was this patch tested?
    
    Doc tests were added and manually tested with the commands below:
    
    `./python/run-tests.py --module pyspark-sql`
    `./python/run-tests.py --module pyspark-sql --python-executable python3`
    `./dev/lint-python`
    
    Output was checked via `make html` under `./python/docs`. The snapshots will be left on the codes with comments.
    
    Author: hyukjinkwon <gurwls223@gmail.com>
    
    Closes #17737 from HyukjinKwon/SPARK-20442.