[GitHub] [spark] HyukjinKwon commented on a change in pull request #31401: [SPARK-34300][PYSPARK][DOCS][MINOR] Fix some typos and syntax issues in docstrings and output of `dev/lint-python`

[GitBox <gi...@apache.org>]

HyukjinKwon commented on a change in pull request #31401:
URL: https://github.com/apache/spark/pull/31401#discussion_r567520914



##########
File path: python/pyspark/sql/avro/functions.py
##########
@@ -37,7 +37,7 @@ def from_avro(data, jsonFormatSchema, options=None):
 
     Parameters
     ----------
-    data : :class:`Column` or str
+    data : :class:`pyspark.sql.Column` or str

Review comment:
       Hm, but `Column` is being imported, and it will be able to be seen via `pyspark.sql.functions.Column` too:
   
   ```python
   >>> from pyspark.sql.functions import Column
   >>>
   ```
   
   I wonder why Sphinx can't detect this automatically.
   
   In any event, the doc structure followed pandas'. It seems like pandas uses the second way too at least for `Series`. So, doing the second way seems okay.
   




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



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