Skip to content

Commit

Permalink
[SPARK-42903][PYTHON][DOCS] Avoid documenting None as as a return val…
Browse files Browse the repository at this point in the history
…ue in docstring

### What changes were proposed in this pull request?
Avoid documenting None as as a return value in docstring.

### Why are the changes needed?
In Python, it's idiomatic to don't specify the return for return None.

### Does this PR introduce _any_ user-facing change?
No.

Closes apache#40532 from xinrong-meng/py_audit.

Authored-by: Xinrong Meng <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
  • Loading branch information
xinrong-meng authored and HyukjinKwon committed Mar 23, 2023
1 parent 39e87d6 commit ece156f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion python/pyspark/sql/functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def lit(col: Any) -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column`, str, int, float, bool or list.
col : :class:`~pyspark.sql.Column`, str, int, float, bool or list, NumPy literals or ndarray.
the value to make it as a PySpark literal. If a column is passed,
it returns the column as is.
Expand Down

0 comments on commit ece156f

Please sign in to comment.