Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: improve version changes formatting #938

Merged
merged 1 commit into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions docs/source/async_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions src/neo4j/_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down
2 changes: 2 additions & 0 deletions src/neo4j/_async/driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/neo4j/_async/work/result.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/neo4j/_sync/driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -823,6 +823,7 @@ def example(driver: neo4j.Driver) -> neo4j.Record::
.. versionadded:: 5.5

.. versionchanged:: 5.8

* Added the ``auth_`` parameter.
* Stabilized from experimental.
"""
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/neo4j/_sync/work/result.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 2 additions & 4 deletions src/neo4j/debug.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down