[GitHub] [spark] dchvn commented on a change in pull request #34210: [SPARK-36713][PYTHON][DOCS] Document new syntax of type hints with index (pandas-on-Spark)

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

dchvn commented on a change in pull request #34210:
URL: https://github.com/apache/spark/pull/34210#discussion_r723875336



##########
File path: python/docs/source/user_guide/pandas_on_spark/typehints.rst
##########
@@ -60,10 +60,10 @@ it as a Spark schema. As an example, you can specify the return type hint as bel
     >>> df = ps.DataFrame({'A': ['a', 'a', 'b'], 'B': [1, 2, 3], 'C': [4, 6, 5]})
     >>> df.groupby('A').apply(pandas_div)
 
-The function ``pandas_div`` actually takes and outputs a pandas DataFrame instead of pandas-on-Spark :class:`DataFrame`.
-However, pandas API on Spark has to force to set the mismatched type hints.
+Notice that the function ``pandas_div`` actually takes and outputs a pandas DataFrame instead of
+pandas-on-Spark :class:`DataFrame`. So, technically the correct types should be pandas'.

Review comment:
       ```pandas'``` is it a typing mistake?

##########
File path: python/docs/source/user_guide/pandas_on_spark/typehints.rst
##########
@@ -139,7 +139,8 @@ programmatically generate the return type and schema.
 
 .. code-block:: python
 
-    >>> def transform(pdf) -> pd.DataFrame[zip(pdf.columns, pdf.dtypes)]:
+    >>> def transform(pdf) -> pd.DataFrame[
+    ..         zip(sample.columns, sample.dtypes)]:

Review comment:
       Should we add sample definition?




-- 
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.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

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