Haejoon Lee created SPARK-46117:
-----------------------------------

             Summary: Enhancing readability of PySpark API reference by hiding 
verbose typehints.
                 Key: SPARK-46117
                 URL: https://issues.apache.org/jira/browse/SPARK-46117
             Project: Spark
          Issue Type: Bug
          Components: Documentation, PySpark
    Affects Versions: 4.0.0
            Reporter: Haejoon Lee


Currently, the PySpark API documentation displays all type hints in the 
signatures, which can make the documentation appear cluttered and less 
readable. By setting `autodoc_typehints` to 'none', we can achieve a cleaner 
and more concise presentation of our API, similar to how the Pandas 
documentation handles type hints. This approach has been effective in Pandas, 
making the documentation more approachable and easier to understand, especially 
for newcomers. 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org

Reply via email to