Documentation improvements.

anthony-tuininga · anthony-tuininga · commit e0efd6f286fb · 2025-03-25T11:29:35.000-06:00
diff --git a/doc/src/api_manual/async_connection.rst b/doc/src/api_manual/async_connection.rst
@@ -146,8 +146,8 @@ AsyncConnection Methods
 
     .. note::
 
-        The data frame support in python-oracledb 3.0.0 is a pre-release and
-        may change in the next version.
+        The data frame support in python-oracledb 3.1 is a pre-release and may
+        change in a future version.
 
     .. versionadded:: 3.0.0
 
@@ -174,8 +174,8 @@ AsyncConnection Methods
 
     .. note::
 
-        The data frame support in python-oracledb 3.0.0 is a pre-release and
-        may change in the next version.
+        The data frame support in python-oracledb 3.1 is a pre-release and may
+        change in a future version.
 
     .. versionadded:: 3.0.0
 
diff --git a/doc/src/api_manual/connection.rst b/doc/src/api_manual/connection.rst
@@ -146,12 +146,18 @@ Connection Methods
     :attr:`Cursor.prefetchrows` size is always set to the value of the explicit
     or default ``arraysize`` parameter value.
 
+    Any LOB fetched must be less than 1 GB.
+
     See :ref:`dataframeformat` for the supported data types and examples.
 
     .. note::
 
-        The data frame support in python-oracledb 3.0.0 is a pre-release and
-        may change in the next version.
+        The data frame support in python-oracledb 3.1 is a pre-release and may
+        change in a future version.
+
+    .. note::
+
+        This method is an extension to the DB API definition.
 
     .. versionadded:: 3.0.0
 
@@ -174,12 +180,18 @@ Connection Methods
     :attr:`Cursor.prefetchrows` sizes are always set to the value of the
     explicit or default ``size`` parameter value.
 
+    Any LOB fetched must be less than 1 GB.
+
     See :ref:`dataframeformat` for the supported data types and examples.
 
     .. note::
 
-        The data frame support in python-oracledb 3.0.0 is a pre-release and
-        may change in the next version.
+        The data frame support in python-oracledb 3.1 is a pre-release and may
+        change in a future version.
+
+    .. note::
+
+        This method is an extension to the DB API definition.
 
     .. versionadded:: 3.0.0
 
diff --git a/doc/src/api_manual/dataframe.rst b/doc/src/api_manual/dataframe.rst
@@ -13,8 +13,8 @@ from Oracle Database types to Arrow data types.
 
 .. note::
 
-    The data frame support in python-oracledb 3.0.0 is a pre-release and may
-    change in the next version.
+    The data frame support in python-oracledb 3.1 is a pre-release and may
+    change in a future version.
 
 .. _oracledataframeobj:
 
diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -19,9 +19,9 @@ Thin Mode Changes
 
 #)  Improved support for :ref:`Oracle Advanced Queuing <aqusermanual>`:
 
-    - added support for JSON payloads
-    - added support for bulk enqueuing and dequeuing
-    - added support for using AQ with asyncio
+    - Added support for JSON payloads
+    - Added support for bulk enqueuing and dequeuing
+    - Added support for using AQ with asyncio
 
 #)  Improved error message when the cryptography package cannot be imported
     (`issue 455 <https://github.com/oracle/python-oracledb/issues/455>`__).
@@ -51,23 +51,19 @@ Thick Mode Changes
 Common Changes
 ++++++++++++++
 
-#)  Improved the performance and memory management of
-    :meth:`Connection.fetch_df_all()` and
-    :meth:`Connection.fetch_df_batches()`:
+#) Improvements to data frame fetching with :meth:`Connection.fetch_df_all()`
+   and :meth:`Connection.fetch_df_batches()`:
 
-    - more efficient processing when a significant amount of data is duplicated
+    - Added support for CLOB, BLOB and RAW data types
+    - Fixed bug when NUMBER data is fetched that does not have a precision or
+      scale specified and :attr:`defaults.fetch_decimals` is set to *True*.
+    - More efficient processing when a significant amount of data is duplicated
       from one row to the next
-    - avoid memory allocation/free cycles for decimal data
-    - eliminated memory leak if OracleDataFrame is not converted to an external
+    - Avoid memory allocation/free cycles for decimal data
+    - Eliminated memory leak if OracleDataFrame is not converted to an external
       data frame
-    - eliminated small memory leak with production of all data frames
-
-#)  Added support for CLOB, BLOB and RAW data types in
-    :meth:`Connection.fetch_df_all()` and :meth:`Connection.fetch_df_batches()`
-#)  Fixed bug when NUMBER data is fetched with
-    :meth:`Connection.fetch_df_all()` or :meth:`Connection.fetch_df_batches()`
-    that does not have precision or scale specified and
-    :attr:`defaults.fetch_decimals` is set to *True*.
+    - Eliminated small memory leak with production of each data frame
+
 #)  Fixed bug when binding a variable that was previously bound as an output
     variable in a DML RETURNING statement.
 #)  An error message that links to :ref:`documentation <ldapconnections>` on
diff --git a/doc/src/user_guide/sql_execution.rst b/doc/src/user_guide/sql_execution.rst
@@ -752,8 +752,8 @@ in `Apache Parquet <https://parquet.apache.org/>`__ format.
 
 .. note::
 
-    The data frame support in python-oracledb 3.0.0 is a pre-release and may
-    change in the next version.
+    The data frame support in python-oracledb 3.1 is a pre-release and may
+    change in a future version.
 
 The method :meth:`Connection.fetch_df_all()` fetches all rows from a query.
 The method :meth:`Connection.fetch_df_batches()` implements an iterator for
