HyukjinKwon commented on a change in pull request #30181:
URL: https://github.com/apache/spark/pull/30181#discussion_r514218306
##########
File path: python/pyspark/sql/context.py
##########
@@ -433,26 +523,34 @@ def clearCache(self):
self._ssql_ctx.clearCache()
@property
- @since(1.4)
def read(self):
"""
Returns a :class:`DataFrameReader` that can be used to read data
in as a :class:`DataFrame`.
- :return: :class:`DataFrameReader`
+ .. versionadded:: 1.4.0
+
+ Returns
+ -------
+ :class:`DataFrameReader`
"""
return DataFrameReader(self)
@property
- @since(2.0)
def readStream(self):
"""
Returns a :class:`DataStreamReader` that can be used to read data
streams
as a streaming :class:`DataFrame`.
- .. note:: Evolving.
+ .. versionadded:: 2.0.0
- :return: :class:`DataStreamReader`
+ Notes
+ -----
+ This API is evolving.
Review comment:
I switched the annotation from `.. note:: Evolving.` to this. I think
user-facing doc should just better have it as prose. Looks like Python side
can't use the annotation like approach unlike Scaladoc or Javadoc.
----------------------------------------------------------------
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
