Ensure defaults are included on a separate line in order to avoid having

a trailing colon, which is treated specially with RST.

Author: anthony-tuininga

src/oracledb/connect_params.py

@@ -114,20 +114,24 @@ def __init__(
         All parameters are optional. A brief description of each parameter
         follows:
 
-        - user: the name of the user to connect to (default: None)
+        - user: the name of the user to connect to
+          (default: None)
 
         - proxy_user: 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]" (default: None)
+          form "user[proxy_user]"
+          (default: None)
 
-        - password: the password for the user (default: None)
+        - password: the password for the user
+          (default: None)
 
         - newpassword: the new password for the user. The new password will
           take effect immediately upon a successful connection to the database
           (default: None)
 
         - wallet_password: the password to use to decrypt the wallet, if it is
-          encrypted. This value is only used in thin mode (default: None)
+          encrypted. This value is only used in thin mode
+          (default: None)
 
         - access_token: expected to be a string or a 2-tuple or a callable. If
           it is a string, it specifies an Azure AD OAuth2 token used for Open
@@ -138,10 +142,12 @@ def __init__(
           either a string or a 2-tuple used for OAuth 2.0 or OCI IAM token
           based authentication and is useful when the pool needs to expand and
           create new connections but the current authentication token has
-          expired (default: None)
+          expired
+          (default: None)
 
         - host: the name or IP address of the machine hosting the database or
-          the database listener (default: None)
+          the database listener
+          (default: None)
 
         - port: the port number on which the database listener is listening
           (default: 1521)
@@ -151,86 +157,105 @@ def __init__(
           (default: "tcp")
 
         - https_proxy: the name or IP address of a proxy host to use for
-          tunneling secure connections (default: None)
+          tunneling secure connections
+          (default: None)
 
         - https_proxy_port: the port on which to communicate with the proxy
-          host (default: 0)
+          host
+          (default: 0)
 
-        - service_name: the service name of the database (default: None)
+        - service_name: the service name of the database
+          (default: None)
 
-        - instance_name: the instance name of the database (default: None)
+        - instance_name: the instance name of the database
+          (default: None)
 
         - sid: the system identifier (SID) of the database. Note using a
-          service_name instead is recommended (default: None)
+          service_name instead is recommended
+          (default: None)
 
         - server_type: the type of server connection that should be
           established. If specified, it should be one of "dedicated", "shared"
-          or "pooled" (default: None)
+          or "pooled"
+          (default: None)
 
         - cclass: connection class to use for Database Resident Connection
-          Pooling (DRCP) (default: None)
+          Pooling (DRCP)
+          (default: None)
 
         - purity: purity to use for Database Resident Connection Pooling (DRCP)
           (default: oracledb.PURITY_DEFAULT)
 
         - expire_time: an integer indicating the number of minutes between the
           sending of keepalive probes. If this parameter is set to a value
-          greater than zero it enables keepalive (default: 0)
+          greater than zero it enables keepalive
+          (default: 0)
 
         - retry_count: the number of times that a connection attempt should be
-          retried before the attempt is terminated (default: 0)
+          retried before the attempt is terminated
+          (default: 0)
 
         - retry_delay: the number of seconds to wait before making a new
-          connection attempt (default: 1)
+          connection attempt
+          (default: 1)
 
         - tcp_connect_timeout: a float indicating the maximum number of seconds
-          to wait for establishing a connection to the database host (default:
-          20.0)
+          to wait for establishing a connection to the database host
+          (default: 20.0)
 
         - ssl_server_dn_match: boolean indicating whether the server
           certificate distinguished name (DN) should be matched in addition to
           the regular certificate verification that is performed. Note that if
           the ssl_server_cert_dn parameter is not privided, host name matching
-          is performed instead (default: True)
+          is performed instead
+          (default: True)
 
         - ssl_server_cert_dn: the distinguished name (DN) which should be
           matched with the server. This value is ignored if the
           ssl_server_dn_match parameter is not set to the value True. If
           specified this value is used for any verfication. Otherwise the
-          hostname will be used (default: None)
+          hostname will be used
+          (default: None)
 
         - wallet_location: the directory where the wallet can be found. In thin
           mode this must be the directory containing the PEM-encoded wallet
           file ewallet.pem. In thick mode this must be the directory containing
-          the file cwallet.sso (default: None)
+          the file cwallet.sso
+          (default: None)
 
         - events: boolean specifying whether events mode should be enabled.
           This value is only used in thick mode and is needed for continuous
           query notification and high availability event notifications
           (default: False)
 
         - externalauth: a boolean indicating whether to use external
-          authentication (default: False)
+          authentication
+          (default: False)
 
         - mode: authorization mode to use. For example
-          oracledb.AUTH_MODE_SYSDBA (default: oracledb.AUTH_MODE_DEFAULT)
+          oracledb.AUTH_MODE_SYSDBA
+          (default: oracledb.AUTH_MODE_DEFAULT)
 
         - disable_oob: boolean indicating whether out-of-band breaks should be
           disabled. This value is only used in thin mode. It has no effect on
-          Windows which does not support this functionality (default: False)
+          Windows which does not support this functionality
+          (default: False)
 
         - stmtcachesize: identifies the initial size of the statement cache
           (default: oracledb.defaults.stmtcachesize)
 
         - edition: edition to use for the connection. This parameter cannot be
-          used simultaneously with the cclass parameter (default: None)
+          used simultaneously with the cclass parameter
+          (default: None)
 
         - tag: identifies the type of connection that should be returned from a
-          pool. This value is only used in thick mode (default: None)
+          pool. This value is only used in thick mode
+          (default: None)
 
         - matchanytag: boolean specifying whether any tag can be used when
           acquiring a connection from the pool. This value is only used in
-          thick mode (default: False)
+          thick mode
+          (default: False)
 
         - config_dir: directory in which the optional tnsnames.ora
           configuration file is located. This value is only used in thin mode.
@@ -239,36 +264,43 @@ def __init__(
 
         - appcontext: application context used by the connection. It should be
           a list of 3-tuples (namespace, name, value) and each entry in the
-          tuple should be a string (default: None)
+          tuple should be a string
+          (default: None)
 
         - shardingkey: a list of strings, numbers, bytes or dates that identify
           the database shard to connect to. This value is only used in thick
-          mode (default: None)
+          mode
+          (default: None)
 
         - supershardingkey: a list of strings, numbers, bytes or dates that
           identify the database shard to connect to. This value is only used in
-          thick mode (default: None)
+          thick mode
+          (default: None)
 
         - debug_jdwp: a string with the format "host=<host>;port=<port>" that
           specifies the host and port of the PL/SQL debugger. This value is
           only used in thin mode. For thick mode set the ORA_DEBUG_JDWP
-          environment variable (default: None)
+          environment variable
+          (default: None)
 
         - connection_id_prefix: an application specific prefix that is added to
-          the connection identifier used for tracing (default: None)
+          the connection identifier used for tracing
+          (default: None)
 
         - ssl_context: an SSLContext object 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 (default: None)
+          cannot be used
+          (default: None)
 
         - sdu: the requested size of the Session Data Unit (SDU), in bytes. The
           value tunes internal buffers used for communication to the database.
           Bigger values can increase throughput for large queries or bulk data
           loads, but at the cost of higher memory use. The SDU size that will
           actually be used is negotiated down to the lower of this value and
-          the database network SDU configuration value (default: 8192)
+          the database network SDU configuration value
+          (default: 8192)
 
         - pool_boundary: one of the values "statement" or "transaction"
           indicating when pooled DRCP connections can be returned to the pool.
@@ -278,27 +310,32 @@ def __init__(
         - use_tcp_fast_open: boolean indicating whether to use TCP fast open.
           This is an Oracle Autonomous Database Serverless (ADB-S) specific
           property for clients connecting from within OCI Cloud network. Please
-          refer to the ADB-S documentation for more information (default:
-          False)
+          refer to the ADB-S documentation for more information
+          (default: False)
 
         - ssl_version: one of the values ssl.TLSVersion.TLSv1_2 or
-          ssl.TLSVersion.TLSv1_3 indicating which TLS version to use (default:
-          None)
+          ssl.TLSVersion.TLSv1_3 indicating which TLS version to use
+          (default: None)
 
         - program: the name of the executable program or application connected
-          to the Oracle Database (default: oracledb.defaults.program)
+          to the Oracle Database
+          (default: oracledb.defaults.program)
 
         - machine: the machine name of the client connecting to the Oracle
-          Database (default: oracledb.defaults.machine)
+          Database
+          (default: oracledb.defaults.machine)
 
         - terminal: the terminal identifier from which the connection
-          originates (default: oracledb.defaults.terminal)
+          originates
+          (default: oracledb.defaults.terminal)
 
         - osuser: the operating system user that initiates the database
-          connection (default: oracledb.defaults.osuser)
+          connection
+          (default: oracledb.defaults.osuser)
 
         - driver_name: the driver name used by the client to connect to the
-          Oracle Database (default: oracledb.defaults.driver_name)
+          Oracle Database
+          (default: oracledb.defaults.driver_name)
 
         - use_sni: boolean indicating whether to use the TLS SNI extension to
           bypass the second TLS neogiation that would otherwise be required
@@ -309,19 +346,22 @@ def __init__(
           parsing by the driver. Setting this to False makes thick and thin
           mode applications behave similarly regarding connection string
           parameter handling and locating any optional tnsnames.ora
-          configuration file (default:
-          oracledb.defaults.thick_mode_dsn_passthrough)
+          configuration file
+          (default: oracledb.defaults.thick_mode_dsn_passthrough)
 
         - extra_auth_params: a dictionary containing configuration parameters
           necessary for Oracle Database authentication using plugins, such as
-          the Azure and OCI cloud-native authentication plugins (default: None)
+          the Azure and OCI cloud-native authentication plugins
+          (default: None)
 
         - pool_name: the name of the DRCP pool when using multi-pool DRCP with
-          Oracle Database 23.4 or higher (default: None)
+          Oracle Database 23.4 or higher
+          (default: None)
 
         - handle: an integer representing a pointer to a valid service context
           handle. This value is only used in thick mode. It should be used with
-          extreme caution (default: 0)
+          extreme caution
+          (default: 0)
         """
         pass