Documentation improvements.

Author: anthony-tuininga

doc/src/api_manual/aq.rst

@@ -25,7 +25,7 @@ Queue Methods
 
     Dequeues up to the specified number of messages from the queue and returns
     a list of these messages. Each element of the returned list is a
-    :ref:`message property<msgproperties>` object.
+    :ref:`message property <msgproperties>` object.
 
     For consistency and compliance with the PEP 8 naming style, the name of
     the method was changed from `deqMany()`. The old name will continue to
@@ -34,8 +34,8 @@ Queue Methods
 .. method:: Queue.deqone()
 
     Dequeues at most one message from the queue. If a message is dequeued, it
-    will be a :ref:`message property<msgproperties>` object; otherwise, it will
-    be the value None.
+    will be a :ref:`message property <msgproperties>` object; otherwise, it will
+    be the value *None*.
 
     For consistency and compliance with the PEP 8 naming style, the name of
     the method was changed from `deqOne()`. The old name will continue to
@@ -85,7 +85,7 @@ Queue Attributes
     <deqoptions>` that will be used when dequeuing messages from the queue.
 
     For consistency and compliance with the PEP 8 naming style, the name of
-    the attribute was changed from `deqOptions`. The old name will continue
+    the attribute was changed from ``deqOptions``. The old name will continue
     to work for a period of time.
 
 .. attribute:: Queue.enqoptions
@@ -94,7 +94,7 @@ Queue Attributes
     <enqoptions>` that will be used when enqueuing messages into the queue.
 
     For consistency and compliance with the PEP 8 naming style, the name of
-    the attribute was changed from `enqOptions`. The old name will continue
+    the attribute was changed from ``enqOptions``. The old name will continue
     to work for a period of time.
 
 .. attribute:: Queue.name
@@ -105,10 +105,10 @@ Queue Attributes
 
     This read-only attribute returns the object type for payloads that can be
     enqueued and dequeued. If using a JSON queue, this returns the value
-    ``"JSON"``. If using a raw queue, this returns the value ``None``.
+    ``"JSON"``. If using a raw queue, this returns the value *None*.
 
     For consistency and compliance with the PEP 8 naming style, the name of
-    the attribute was changed from `payloadType`. The old name will
+    the attribute was changed from ``payloadType``. The old name will
     continue to work for a period of time.
 
 
@@ -311,7 +311,7 @@ Message Properties
 
     This read-only attribute specifies the id of the message in the last queue
     that enqueued or dequeued the message. If the message has never been
-    dequeued or enqueued, the value will be `None`.
+    dequeued or enqueued, the value will be *None*.
 
 
 .. attribute:: MessageProperties.payload
@@ -327,7 +327,7 @@ Message Properties
 
     This read-write attribute specifies the priority of the message. A smaller
     number indicates a higher priority. The priority can be any integer, including
-    negative numbers. The default value is zero.
+    negative numbers. The default value is *0*.
 
 
 .. attribute:: MessageProperties.state

doc/src/api_manual/async_connection.rst

@@ -160,10 +160,10 @@ AsyncConnection Methods
                 rowfactory=None)
 
     Executes a query and returns the first row of the result set if one exists
-    (or None if no rows exist).
+    (or *None* if no rows exist).
 
     Internally, this method's :attr:`Cursor.prefetchrows` and
-    :attr:`Cursor.arraysize` sizes will be set to 1.
+    :attr:`Cursor.arraysize` sizes will be set to *1*.
 
     Since only one fetch is performed for a query, consider adding a ``WHERE``
     condition or using a ``FETCH NEXT`` clause in the statement to prevent the
@@ -191,8 +191,8 @@ AsyncConnection Methods
     existing standalone connection. Pooled connections internally perform this
     check before returning a connection to the application.
 
-    If this function returns False, the connection should be not be used by the
-    application and a new connection should be established instead.
+    If this function returns *False*, the connection should be not be used by
+    the application and a new connection should be established instead.
 
     This function performs a local check. To fully check a connection's health,
     use :meth:`AsyncConnection.ping()` which performs a :ref:`round-trip
@@ -214,11 +214,11 @@ AsyncConnection Methods
 
     The ``continue_on_error`` parameter determines whether operations should
     continue to run after an error has occurred. If this parameter is set to
-    True, then the :attr:`PipelineOpResult.error` attribute will be populated
+    *True*, then the :attr:`PipelineOpResult.error` attribute will be populated
     with an :ref:`_Error <exchandling>` instance which identifies the error
-    that occurred. If this parameter is set to False, then an exception will be
-    raised as soon as an error is detected and all subsequent operations will
-    be terminated. The default value is False.
+    that occurred. If this parameter is set to *False*, then an exception will
+    be raised as soon as an error is detected and all subsequent operations
+    will be terminated. The default value is *False*.
 
     See :ref:`pipelining` for more information.
 
@@ -258,7 +258,7 @@ AsyncConnection Methods
     transaction can be inactive before it is automatically terminated by the
     system. A transaction is inactive between the time it is detached with
     :meth:`AsyncConnection.tpc_end()` and the time it is resumed with
-    :meth:`AsyncConnection.tpc_begin()`.The default is 0 seconds.
+    :meth:`AsyncConnection.tpc_begin()`.The default is *0* seconds.
 
     The following code sample demonstrates the ``tpc_begin()`` function::
 
@@ -284,8 +284,8 @@ AsyncConnection Methods
     transaction and is intended for use in recovery.
 
     The ``one_phase`` parameter is a boolean identifying whether to perform a
-    one-phase or two-phase commit. If ``one_phase`` parameter is True, a
-    single-phase commit is performed.  The default value is False. This
+    one-phase or two-phase commit. If ``one_phase`` parameter is *True*, a
+    single-phase commit is performed.  The default value is *False*. This
     parameter is only examined if a value is provided for the ``xid``
     parameter. Otherwise, the driver already knows whether
     :meth:`~AsyncConnection.tpc_prepare()` was called for the transaction and
@@ -356,8 +356,8 @@ AsyncConnection Methods
     ``ORA-24756: transaction does not exist``.
 
     If an ``xid`` parameter is passed, then an object should be returned by the
-    :meth:`~Connection.xid()` function. If an xid parameter is not passed, then
-    the transaction identifier used by the previous
+    :meth:`~Connection.xid()` function. If an ``xid`` parameter is not passed,
+    then the transaction identifier used by the previous
     :meth:`~AsyncConnection.tpc_begin()` is used.
 
     The following code sample demonstrates the ``tpc_prepare()`` function::
@@ -417,7 +417,7 @@ AsyncConnection Attributes
 .. attribute:: AsyncConnection.action
 
     This write-only attribute sets the ACTION column in the V$SESSION view. It
-    is a string attribute but the value None is accepted and treated as an
+    is a string attribute but the value *None* is accepted and treated as an
     empty string.
 
 .. attribute:: AsyncConnection.autocommit
@@ -430,10 +430,10 @@ AsyncConnection Attributes
 
     This read-write attribute specifies the amount of time (in milliseconds)
     that a single round-trip to the database may take before a timeout will
-    occur. A value of 0 means that no timeout will take place.
+    occur. A value of *0* means that no timeout will take place.
 
-    If a timeout occurs, the error *DPI-1067* will be returned if the
-    connection is still usable.  Alternatively the error *DPI-1080* will be
+    If a timeout occurs, the error ``DPI-1067`` will be returned if the
+    connection is still usable.  Alternatively, the error ``DPI-1080`` will be
     returned if the connection has become invalid and can no longer be used.
 
 .. attribute:: AsyncConnection.client_identifier
@@ -498,9 +498,10 @@ AsyncConnection Attributes
     This read-write attribute specifies a method called for each value that is
     bound to a statement executed on any cursor associated with this
     connection.  The method signature is handler(cursor, value, arraysize) and
-    the return value is expected to be a variable object or None in which case
-    a default variable object will be created. If this attribute is None, the
-    default behavior will take place for all values bound to statements.
+    the return value is expected to be a variable object or *None* in which
+    case a default variable object will be created. If this attribute is
+    *None*, the default behavior will take place for all values bound to
+    statements.
 
 .. attribute:: AsyncConnection.instance_name
 
@@ -545,15 +546,15 @@ AsyncConnection Attributes
 
     This write-only attribute sets the MODULE column in the V$SESSION view.
     The maximum length for this string is 48 and if you exceed this length you
-    will get ORA-24960.
+    will get ``ORA-24960``.
 
 .. attribute:: AsyncConnection.outputtypehandler
 
     This read-write attribute specifies a method called for each column that is
     going to be fetched from any cursor associated with this connection. The
     method signature is ``handler(cursor, metadata)`` and the return value is
-    expected to be a :ref:`variable object<varobj>` or None in which case a
-    default variable object will be created. If this attribute is None, the
+    expected to be a :ref:`variable object <varobj>` or *None* in which case a
+    default variable object will be created. If this attribute is *None*, the
     default behavior will take place for all columns fetched from cursors.
 
     See :ref:`outputtypehandlers`.
@@ -615,15 +616,15 @@ AsyncConnection Attributes
     value can make a significant difference in performance if you have a small
     number of statements that you execute repeatedly.
 
-    The default value is 20.
+    The default value is *20*.
 
     See :ref:`Statement Caching <stmtcache>` for more information.
 
 .. attribute:: AsyncConnection.thin
 
     This read-only attribute returns a boolean indicating if the connection was
-    established with the python-oracledb Thin mode (True) or python-oracledb
-    Thick mode (False).
+    established with the python-oracledb Thin mode (*True*) or python-oracledb
+    Thick mode (*False*).
 
 .. attribute:: AsyncConnection.transaction_in_progress
 

doc/src/api_manual/async_connection_pool.rst

@@ -124,7 +124,7 @@ AsyncConnectionPool Attributes
     closed. They become candidates for termination only when they are released
     back to the pool and have existed for longer than max_lifetime_session
     seconds. Note that termination only occurs when the pool is accessed. A
-    value of 0 means that there is no maximum length of time that a pooled
+    value of *0* means that there is no maximum length of time that a pooled
     connection may exist. This attribute is only available in Oracle Database
     12.1 or later.
 
@@ -158,11 +158,11 @@ AsyncConnectionPool Attributes
     <roundtrips>` ping to the database is performed. If the connection is
     unusable, it is discarded and a different connection is selected to be
     returned by :meth:`AsyncConnectionPool.acquire()`.  Setting
-    ``ping_interval`` to a negative value disables pinging.  Setting it to 0
+    ``ping_interval`` to a negative value disables pinging.  Setting it to *0*
     forces a ping for every :meth:`AsyncConnectionPool.acquire()` and is not
     recommended.
 
-    Prior to cx_Oracle 8.2, the ping interval was fixed at 60 seconds.
+    Prior to cx_Oracle 8.2, the ping interval was fixed at *60* seconds.
 
 .. attribute:: AsyncConnectionPool.soda_metadata_cache
 
@@ -175,23 +175,23 @@ AsyncConnectionPool Attributes
     This read-write attribute specifies the size of the statement cache that
     will be used for connections obtained from the pool. Once a connection is
     created, that connection’s statement cache size can only be changed by
-    setting the stmtcachesize attribute on the connection itself.
+    setting the ``stmtcachesize`` attribute on the connection itself.
 
     See :ref:`Statement Caching <stmtcache>` for more information.
 
 .. attribute:: AsyncConnectionPool.thin
 
     This attribute returns a boolean which indicates the python-oracledb mode
-    in which the pool was created. If the value of this attribute is True, it
+    in which the pool was created. If the value of this attribute is *True*, it
     indicates that the pool was created in the python-oracledb Thin mode. If
-    the value of this attribute is False, it indicates that the pool was created
-    in the python-oracledb Thick mode.
+    the value of this attribute is *False*, it indicates that the pool was
+    created in the python-oracledb Thick mode.
 
 .. attribute:: AsyncConnectionPool.timeout
 
     This read-write attribute specifies the time (in seconds) after which idle
     connections will be terminated in order to maintain an optimum number of
-    open connections. A value of 0 means that no idle connections are
+    open connections. A value of *0* means that no idle connections are
     terminated.
 
 .. attribute:: AsyncConnectionPool.username