Skip to content

Commit e7a7ec9

Browse files
committed
fix: correct formatting in documentation for RecordBatchStream
1 parent d120b2e commit e7a7ec9

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/source/user-guide/dataframe/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ Asynchronous iteration is supported as well, allowing integration with
254254
... # process each batch as it is produced
255255
256256
To work with the stream directly, use ``execute_stream()``, which returns a
257-
:class:`~datafusion.RecordBatchStream`::
257+
:class:`~datafusion.RecordBatchStream`.
258258

259259
.. code-block:: python
260260
@@ -278,8 +278,9 @@ For finer control over streaming execution, use
278278
.. tip::
279279

280280
To get a PyArrow reader instead, call
281-
``pa.RecordBatchReader.from_stream(df)``.
282281

282+
``pa.RecordBatchReader.from_stream(df)``.
283+
283284
When partition boundaries are important,
284285
:py:meth:`~datafusion.DataFrame.execute_stream_partitioned`
285286
returns an iterable of :py:class:`datafusion.RecordBatchStream` objects, one per

0 commit comments

Comments
 (0)