Documentation improvements.

Author: anthony-tuininga

doc/src/api_manual/connect_param.rst

@@ -32,10 +32,19 @@ ConnectParams Methods
   pairs, or a simple alias which is looked up in ``tnsnames.ora``. Parameters
   that are found in the connect string override any currently stored values.
 
-.. method:: ConnectParams.set()
+.. method:: ConnectParams.set(user=None, proxy_user=None, password=None, \
+    newpassword=None, wallet_password=None, host=None, port=None, protocol=None, \
+    https_proxy=None, https_proxy_port=None, service_name=None, sid=None, \
+    server_type=None, cclass=None, purity=None, expire_time=None, retry_count=None, \
+    retry_delay=None, tcp_connect_timeout=None, ssl_server_dn_match=None, \
+    ssl_server_cert_dn=None, wallet_location=None, events=None, mode=None, \
+    disable_oob=None, stmtcachesize=None, edition=None, tag=None, matchanytag=None, \
+    config_dir=None, appcontext=[], shardingkey=[], supershardingkey=[], debug_jdwp=None, \
+    handle=None)
 
   Sets one or more of the parameters.
 
+
 .. _connparamsattr:
 
 ConnectParams Attributes

doc/src/api_manual/module.rst

@@ -500,6 +500,18 @@ Oracledb Methods
     The ``user``, ``password`` and ``dsn`` parameters are the same as for
     :meth:`oracledb.connect()`.
 
+    The ``pool_class`` parameter is expected to be a :ref:`ConnectionPool Object
+    <connpool>` or a subclass of ConnectionPool.
+
+    The ``params`` parameter is expected to be of type :ref:`PoolParams
+    <poolparam>` and contains parameters that are used to create the pool.  If
+    this parameter is not specified, the additional keyword arguments will be
+    used to create an instance of PoolParams. If both the params parameter and
+    the additional keyword parameters are specified, then an exception is
+    raised. Note that if a ``dsn`` parameter is also specified, then the
+    ``params`` parameter will be modified to contain the connection parameters
+    found within ``dsn``.
+
     The ``min``, ``max`` and ``increment`` parameters control pool growth
     behavior. A fixed pool size where ``min`` equals ``max`` is
     :ref:`recommended <connpoolsize>` to help prevent connection storms and to
@@ -561,18 +573,6 @@ Oracledb Methods
     negative value, then the ping functionality will be disabled. The default
     value is 60 seconds.
 
-    The ``pool_class`` parameter is expected to be a :ref:`ConnectionPool Object
-    <connpool>` or a subclass of ConnectionPool.
-
-    The ``params`` parameter is expected to be of type :ref:`PoolParams
-    <poolparam>` and contains parameters that are used to create the pool.  If
-    this parameter is not specified, the additional keyword arguments will be
-    used to create an instance of PoolParams. If both the params parameter and
-    the additional keyword parameters are specified, then an exception is
-    raised. Note that if a ``dsn`` parameter is also specified, then the
-    ``params`` parameter will be modified to contain the connection parameters
-    found within ``dsn``.
-
     The ``proxy_user`` parameter is expected to be a string which indicates the
     name of the proxy user to connect to. If this value is not specified, it
     will be parsed out of user if user is in the form "user[proxy_user]". This

doc/src/api_manual/pool_params.rst

@@ -32,7 +32,15 @@ PoolParams Methods
   which is looked up in ``tnsnames.ora``. Parameters that are found in the connect string
   override any currently stored values.
 
-.. method:: PoolParams.set()
+.. method:: PoolParams.set(user=None, proxy_user=None, password=None, \
+    newpassword=None, wallet_password=None, host=None, port=None, protocol=None, \
+    https_proxy=None, https_proxy_port=None, service_name=None, sid=None, \
+    server_type=None, cclass=None, purity=None, expire_time=None, retry_count=None, \
+    retry_delay=None, tcp_connect_timeout=None, ssl_server_dn_match=None, \
+    ssl_server_cert_dn=None, wallet_location=None, events=None, mode=None, \
+    disable_oob=None, stmtcachesize=None, edition=None, tag=None, matchanytag=None, \
+    config_dir=None, appcontext=[], shardingkey=[], supershardingkey=[], debug_jdwp=None, \
+    handle=None)
 
   Sets one or more of the parameters.
 

doc/src/release_notes.rst

@@ -12,9 +12,10 @@ oracledb 1.0 (May 2022)
 -----------------------
 
 #)  Renamed cx_Oracle to python-oracledb.  See :ref:`upgradecomparison`.
-#)  Introduced a 'Thin' mode that connects directly to Oracle Database without
-    needing Oracle Client libraries.  Thin mode is the default. To use Thick
-    mode, see :ref:`enablingthick`.
+#)  Python-oracledb is a 'Thin' driver by default that connects directly
+    to Oracle Database.  Optional use of Oracle Client libraries enables a
+    :ref:`'Thick' mode <enablingthick>` with some additional functionality.
+    Both modes support the Python Database API v2.0 Specification.
 #)  Added a :attr:`Connection.thin` attribute which shows whether the
     connection was established in the python-oracledb Thin mode or Thick mode.
 #)  Creating connections or connection pools now requires :ref:`keyword