zero323 edited a comment on issue #26004: 
[SPARK-29142][PYTHON][ML][FOLLOWUP][DOC] Replace incorrect :py:attr: 
applications
URL: https://github.com/apache/spark/pull/26004#issuecomment-537861691
 
 
   @dongjoon-hyun Technically speaking it doesn't introduce any user-facing 
change, as we don't render docs for internal ([leading 
`_`](https://www.python.org/dev/peps/pep-0008/#id36)) objects. So as such, this 
PR is just a minor style fix (if you still think it should be marked as 
introducing user-facing changes, I will revert the changes in the description - 
I didn't realize you modified, and changed back to "No", thinking I made a 
mistake. Sorry...).
   
   As of screenshots - we can re-render the docs to show the *potential* 
effect, but it requires changes in the build definition (I already cleared 
build environment) and doesn't show the problem (which is target source, not 
rendering as such). I can do that, if you find it necessary, but personally I 
think that Sphinx reference 
([`:py:class:`](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py:class)
 vs. 
[`:py:attr:`](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py:attr))
 and Spark source (see how we reference classes, for example in `ml.features`, 
[here](https://github.com/apache/spark/blob/ee66890f30bc23b5c71afe7c46ac1414585d4f3a/python/pyspark/ml/feature.py#L319),
 
[here](https://github.com/apache/spark/blob/ee66890f30bc23b5c71afe7c46ac1414585d4f3a/python/pyspark/ml/feature.py#L664)
 and 
[here](https://github.com/apache/spark/blob/ee66890f30bc23b5c71afe7c46ac1414585d4f3a/python/pyspark/ml/feature.py#L869)).
   

----------------------------------------------------------------
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:
[email protected]


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to