Docs: improve version changes formatting (#938)

Author: robsdedude

docs/source/api.rst

@@ -372,16 +372,10 @@ Closing a driver will immediately shut down all connections in the pool.
         :returns: the result of the ``result_transformer``
         :rtype: T
 
-        **This is experimental** (see :ref:`filter-warnings-ref`).
-        It might be changed or removed any time even without prior notice.
-
-        We are looking for feedback on this feature. Please let us know what
-        you think about it here:
-        https://github.com/neo4j/neo4j-python-driver/discussions/896
-
         .. versionadded:: 5.5
 
         .. versionchanged:: 5.8
+
             * Added the ``auth_`` parameter.
             * Stabilized from experimental.
 

docs/source/async_api.rst

@@ -362,6 +362,7 @@ Closing a driver will immediately shut down all connections in the pool.
         .. versionadded:: 5.5
 
         .. versionchanged:: 5.8
+
             * Added the ``auth_`` parameter.
             * Stabilized from experimental.
 

src/neo4j/_api.py

@@ -219,6 +219,7 @@ class RoutingControl(str, Enum):
     .. versionadded:: 5.5
 
     .. versionchanged:: 5.8
+
         * renamed ``READERS`` to ``READ`` and ``WRITERS`` to ``WRITE``
         * stabilized from experimental
     """

src/neo4j/_async/driver.py

@@ -824,6 +824,7 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record::
         .. versionadded:: 5.5
 
         .. versionchanged:: 5.8
+
             * Added the ``auth_`` parameter.
             * Stabilized from experimental.
         """
@@ -886,6 +887,7 @@ async def example(driver: neo4j.AsyncDriver) -> None:
         .. versionadded:: 5.5
 
         .. versionchanged:: 5.8
+
             * Renamed from ``query_bookmark_manager`` to
               ``execute_query_bookmark_manager``.
             * Stabilized from experimental.

src/neo4j/_async/work/result.py

@@ -443,9 +443,9 @@ async def single(self, strict: bool = False) -> t.Optional[Record]:
             consumed.
 
         .. versionchanged:: 5.0
-            Added ``strict`` parameter.
-        .. versionchanged:: 5.0
-            Can raise :exc:`ResultConsumedError`.
+
+            * Added ``strict`` parameter.
+            * Can raise :exc:`ResultConsumedError`.
         """
         await self._buffer(2)
         buffer = self._record_buffer

src/neo4j/_sync/driver.py

@@ -823,6 +823,7 @@ def example(driver: neo4j.Driver) -> neo4j.Record::
         .. versionadded:: 5.5
 
         .. versionchanged:: 5.8
+
             * Added the ``auth_`` parameter.
             * Stabilized from experimental.
         """
@@ -885,6 +886,7 @@ def example(driver: neo4j.Driver) -> None:
         .. versionadded:: 5.5
 
         .. versionchanged:: 5.8
+
             * Renamed from ``query_bookmark_manager`` to
               ``execute_query_bookmark_manager``.
             * Stabilized from experimental.

src/neo4j/_sync/work/result.py

@@ -443,9 +443,9 @@ def single(self, strict: bool = False) -> t.Optional[Record]:
             consumed.
 
         .. versionchanged:: 5.0
-            Added ``strict`` parameter.
-        .. versionchanged:: 5.0
-            Can raise :exc:`ResultConsumedError`.
+
+            * Added ``strict`` parameter.
+            * Can raise :exc:`ResultConsumedError`.
         """
         self._buffer(2)
         buffer = self._record_buffer

src/neo4j/debug.py

@@ -106,8 +106,7 @@ class Watcher:
     :param task_info: whether to include information about the current
         async task in the log message. Defaults to :const:`True`.
 
-    .. versionchanged::
-        5.3
+    .. versionchanged:: 5.3
 
         * Added ``thread_info`` and ``task_info`` parameters.
         * Logging format around thread and task information changed.
@@ -219,8 +218,7 @@ def watch(
     :returns: Watcher instance
     :rtype: :class:`.Watcher`
 
-    .. versionchanged::
-        5.3
+    .. versionchanged:: 5.3
 
         * Added ``thread_info`` and ``task_info`` parameters.
         * Logging format around thread and task information changed.