[GitHub] [spark] HyukjinKwon opened a new pull request #25060: [SPARK-28206][PYTHON] Remove the legacy Epydoc in PySpark API documentation

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

HyukjinKwon opened a new pull request #25060: [SPARK-28206][PYTHON] Remove the legacy Epydoc in PySpark API documentation
URL: https://github.com/apache/spark/pull/25060
 
 
   ## What changes were proposed in this pull request?
   
   Seems like we used to generate PySpark API documentation by Epydoc almost at the very first place (see https://github.com/apache/spark/commit/85b8f2c64f0fc4be5645d8736629fc082cb3587b).
   
   This fixes an actual issue:
   
   Before:
   
   ![Screen Shot 2019-07-05 at 8 20 01 PM](https://user-images.githubusercontent.com/6477701/60720491-e9879180-9f65-11e9-9562-100830a456cd.png)
   
   After:
   
   ![Screen Shot 2019-07-05 at 8 20 05 PM](https://user-images.githubusercontent.com/6477701/60720495-ec828200-9f65-11e9-8277-8f689e292cb0.png)
   
   It seems apparently a bug within `epytext` plugin (see `@param` <> `:param` syntax and [Epydoc syntax](http://epydoc.sourceforge.net/manual-epytext.html))
   
   Actually, Epydoc syntax violates [PEP-257](https://www.python.org/dev/peps/pep-0257/) and blocks us to enable doctest linter as well.
   
   We should remove this legacy away and I guess Spark 3 is good timing to do it.
   
   ## How was this patch tested?
   
   Manually built the doc and check each.
   

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


With regards,
Apache Git Services

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