[
https://issues.apache.org/jira/browse/SPARK-16782?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15398059#comment-15398059
]
Nicholas Chammas commented on SPARK-16782:
------------------------------------------
[~davies] [~joshrosen] - I can take this on if the idea sounds good to you.
One thing I will have to look into is how the doctests show up, since we don't
want those to be identical (or do we?) due to the different invocation methods.
I'm not sure if autodoc will make that possible.
> Use Sphinx autodoc to eliminate duplication of Python docstrings
> ----------------------------------------------------------------
>
> Key: SPARK-16782
> URL: https://issues.apache.org/jira/browse/SPARK-16782
> Project: Spark
> Issue Type: Improvement
> Components: Documentation, PySpark
> Reporter: Nicholas Chammas
> Priority: Minor
>
> In several cases it appears that we duplicate docstrings for methods that are
> exposed in multiple places.
> For example, here are two instances of {{createDataFrame}} with identical
> docstrings:
> *
> https://github.com/apache/spark/blob/ab6e4aea5f39c429d5ea62a5170c8a1da612b74a/python/pyspark/sql/context.py#L218
> *
> https://github.com/apache/spark/blob/39c836e976fcae51568bed5ebab28e148383b5d4/python/pyspark/sql/session.py#L406
> I believe we can eliminate this duplication by using the [Sphinx autodoc
> extension|http://www.sphinx-doc.org/en/stable/ext/autodoc.html].
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
