Github user rekhajoshm commented on the issue:
https://github.com/apache/spark/pull/20378
Thanks @HyukjinKwon for your update.
@HyukjinKwon @holdenk @ueshin @viirya @icexelloss @felixcheung
@BryanCutler and @MrBago - While you are thinking on it, below is my analysis.
As I understand, there are two things that jira "seems" to be calling
out.Please validate.
1. doctest strings must be correctly formatted.
2. Doctest must NOT be included in docs?
Working on it, I found docstring style itself was not enforced at all, and
that includes doctest style.
Another aspect seems to be exclude doctest from documentation (_build/html
once generated.)
I am not certain on the reasoning behind this exclusion or whether it is
indeed what is additionally intended in SPARK-11222.The jira subject and
description say two different things, so maybe validate that understanding?
Meanwhile I had a look into/tested different configurations on
epytext/sphinx extensions to see if we can achieve surpassing doctests in docs
via them.
Played with RULES set in epytext.py. As per epytext manual
http://epydoc.sourceforge.net/manual-epytext.html it ensures only correctly
formatted doctests are rendered.Which means only if they were incorrectly
formatted will they not to appear in docs.This did not seem right and contrary
even.
So I played around with sphinx extensions -
'sphinx.ext.doctest',
'sphinx.ext.napoleon'
and in conf.py -
# Napoleon settings
napoleon_google_docstring = True
# Doctest settings
doctest_test_doctest_blocks=''
trim_doctest_flags=True
None of those options tried get me to surpass doctest in docs(_build/html)
once the build is done.
Thanks for thinking this over.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
