From 73540a4154f27a74e5b32d4b397f1a74130ea8d3 Mon Sep 17 00:00:00 2001 From: Robsdedude <rouven.bauer@neo4j.com> Date: Thu, 20 Apr 2023 12:16:27 +0200 Subject: [PATCH] Clarify parameter precedence in execute_query docs --- docs/source/api.rst | 3 ++- docs/source/async_api.rst | 3 ++- src/neo4j/_async/driver.py | 3 ++- src/neo4j/_sync/driver.py | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index 93a92c169..e720a789d 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -364,7 +364,8 @@ Closing a driver will immediately shut down all connections in the pool. with a single underscore. This is to avoid collisions with the keyword configuration parameters of this method. If you need to pass such a parameter, use the ``parameters_`` parameter instead. - These take precedence over parameters passed as ``parameters_``. + Parameters passed as kwargs take precedence over those passed in + ``parameters_``. :type kwargs: typing.Any :returns: the result of the ``result_transformer`` diff --git a/docs/source/async_api.rst b/docs/source/async_api.rst index c29d1227c..c3593c34b 100644 --- a/docs/source/async_api.rst +++ b/docs/source/async_api.rst @@ -354,7 +354,8 @@ Closing a driver will immediately shut down all connections in the pool. with a single underscore. This is to avoid collisions with the keyword configuration parameters of this method. If you need to pass such a parameter, use the ``parameters_`` parameter instead. - These take precedence over parameters passed as ``parameters_``. + Parameters passed as kwargs take precedence over those passed in + ``parameters_``. :type kwargs: typing.Any :returns: the result of the ``result_transformer`` diff --git a/src/neo4j/_async/driver.py b/src/neo4j/_async/driver.py index 9bc682930..7cb03c5c3 100644 --- a/src/neo4j/_async/driver.py +++ b/src/neo4j/_async/driver.py @@ -815,7 +815,8 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record:: with a single underscore. This is to avoid collisions with the keyword configuration parameters of this method. If you need to pass such a parameter, use the ``parameters_`` parameter instead. - These take precedence over parameters passed as ``parameters_``. + Parameters passed as kwargs take precedence over those passed in + ``parameters_``. :type kwargs: typing.Any :returns: the result of the ``result_transformer`` diff --git a/src/neo4j/_sync/driver.py b/src/neo4j/_sync/driver.py index 769c9dfe6..96b1b76e8 100644 --- a/src/neo4j/_sync/driver.py +++ b/src/neo4j/_sync/driver.py @@ -814,7 +814,8 @@ def example(driver: neo4j.Driver) -> neo4j.Record:: with a single underscore. This is to avoid collisions with the keyword configuration parameters of this method. If you need to pass such a parameter, use the ``parameters_`` parameter instead. - These take precedence over parameters passed as ``parameters_``. + Parameters passed as kwargs take precedence over those passed in + ``parameters_``. :type kwargs: typing.Any :returns: the result of the ``result_transformer``