Documentation improvements.

anthony-tuininga · anthony-tuininga · commit ddac90bd610f · 2023-12-05T16:58:31.000-07:00
diff --git a/doc/src/api_manual/aq.rst b/doc/src/api_manual/aq.rst
@@ -340,7 +340,7 @@ Message Properties
     :data:`~oracledb.MSG_READY`, :data:`~oracledb.MSG_PROCESSED` or
     :data:`~oracledb.MSG_EXPIRED`.
 
-.. attribute:: Messageproperties.recipient
+.. attribute:: MessageProperties.recipients
 
     This read-write attribute specifies a list of recipient names that can be
     associated with a message at the time of enqueuing the message. This allows a
diff --git a/doc/src/api_manual/connect_param.rst b/doc/src/api_manual/connect_param.rst
@@ -279,14 +279,17 @@ ConnectParams Attributes
 
 .. attribute:: ConnectParams.ssl_context
 
-    This read-only attribute is an SSLContext object which is used for
-    connecting to the database using TLS. This SSL context will be modified to
-    include the private key or any certificates found in a separately supplied
-    wallet. This parameter should only be specified if the default SSLContext
-    object cannot be used.
+    This read-only attribute is an `SSLContext object
+    <https://docs.python.org/3/library/ssl.html#ssl-contexts>`__ which is used
+    for connecting to the database using TLS. This SSL context will be modified
+    to include the private key or any certificates found in a separately
+    supplied wallet. This parameter should only be specified if the default
+    SSLContext object cannot be used.
 
     This attribute is only supported in the python-oracledb Thin mode.
 
+    .. versionadded:: 2.0.0
+
 .. attribute:: ConnectParams.ssl_server_cert_dn
 
     This read-only attribute is a string that returns the distinguished name
diff --git a/doc/src/api_manual/connection.rst b/doc/src/api_manual/connection.rst
@@ -827,6 +827,8 @@ Connection Attributes
     This read-only attribute returns the name of the user which was used as a
     proxy when creating the connection to the database.
 
+    .. versionadded:: 2.0.0
+
     .. note::
 
         This attribute is an extension to the DB API definition.
diff --git a/doc/src/api_manual/module.rst b/doc/src/api_manual/module.rst
@@ -2352,6 +2352,8 @@ when binding data.
     Describes columns, attributes or array elements in a database that are of
     type SYS.XMLTYPE.
 
+    .. versionadded:: 2.0.0
+
 
 .. _dbtypesynonyms:
 
diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -15,14 +15,15 @@ Thin Mode Changes
 
 #)  Fixed bug in detecting the current time zone
     (`issue 257 <https://github.com/oracle/python-oracledb/issues/257>`__).
-#)  Added parameter :data:`ConnectParams.ssl_context`
+#)  Added connection establishment parameter :data:`ConnectParams.ssl_context`
     (`issue 259 <https://github.com/oracle/python-oracledb/issues/259>`__).
 #)  Fixed bug in handling database response in certain unusual circumstances.
 #)  Fixed bug in handling exceptions raised during connection establishment.
 #)  Fixed bug in identifying bind variables in SQL statements containing
     multiple line comments with multiple asterisks before the closing slash.
+#)  Added support for the ``FAILOVER`` clause in full connect descriptors.
 #)  A more meaningful error is raised when the wrong type of data is passed to
-    lob.write().
+    :meth:`LOB.write()`.
 #)  Internal changes to improve handling of the network protocol between
     python-oracledb and Oracle Database.
 #)  Internal changes to improve handling of multiple address and description
@@ -55,15 +56,15 @@ Common Changes
     :data:`FetchInfo.type_code` for data of this type was
     :data:`~oracledb.DB_TYPE_LONG` in Thick mode and
     :data:`~oracledb.DB_TYPE_OBJECT` in Thin mode.
-#)  Attribute and element values of DbObject instances that are numbers are now
-    returned as integers if the precision and scale allow for it -- in the same
-    way that numbers are fetched from the database
+#)  Attribute and element values of :ref:`Oracle Object <dbobject>`
+    instances that are numbers are now returned as integers if the precision
+    and scale allow for it -- in the same way that numbers are fetched from the
+    database
     (`issue 99 <https://github.com/oracle/python-oracledb/issues/99>`__).
-#)  Added support for parsing the ``FAILOVER`` clause in full connect
-    descriptors.
 #)  Fixed bug with getting unknown attributes from DbObject instances.
-#)  Errors that have entries in the troubleshooting documentation now have
-    links to that documentation included in the message text.
+#)  Errors that have entries in the
+    :ref:`troubleshooting documentation <troubleshooting>` now have links to
+    that documentation included in the message text.
 #)  The attribute ``oracledb.__future__.old_json_col_as_obj`` no longer needs
     to be set in order to fetch JSON data found in VARCHAR2 and LOB columns in
     the same way that JSON columns (which requires Oracle Database 21c or
diff --git a/doc/src/user_guide/appendix_a.rst b/doc/src/user_guide/appendix_a.rst
@@ -521,9 +521,9 @@ values.
       - Not supported in python-oracledb Thin mode
       - n/a
     * - XMLType
-      - n/a
-      - Not supported in python-oracledb. Use ``xmltype.getclobval()`` to fetch.
-      - n/a
+      - DB_TYPE_XMLTYPE
+      - Yes. May need to use ``xmltype.getclobval()`` to fetch in python-oracledb Thick mode.
+      - bytes, str
     * - User-defined types (object type, VARRAY, records, collections, SDO_*types)
       - DB_TYPE_OBJECT
       - Yes
diff --git a/doc/src/user_guide/troubleshooting.rst b/doc/src/user_guide/troubleshooting.rst
@@ -154,7 +154,7 @@ DPI Error Messages
 
 The error messages with prefix ``DPI`` are generated by the
 `ODPI-C <https://oracle.github.io/odpi/>`_ code which is used by the
-python-oraclebd Thick mode.
+python-oracledb Thick mode.
 
 DPI-1047
 ++++++++
@@ -202,8 +202,8 @@ Client library could not be loaded.
 - On Windows:
 
   - If you have a full database installation, ensure that this database is the
-    `currently configured database <https://www.oracle.com/pls/topic/lookup?
-    ctx=dblatest&id=GUID-33D575DD-47FF-42B1-A82F-049D3F2A8791>`__.
+    `currently configured database <https://docs.oracle.com/pls/topic/lookup?
+    ctx=db21&id=RIWIN-GUID-33D575DD-47FF-42B1-A82F-049D3F2A8791>`__.
 
   - If you are not passing a library directory parameter to
     :meth:`oracledb.init_oracle_client()`, then restart your command prompt
