Skip to content

Commit 5ad2b6f

Browse files
authored
Clarify parameter precedence in execute_query docs (#919)
1 parent cf2c75c commit 5ad2b6f

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

docs/source/api.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,8 @@ Closing a driver will immediately shut down all connections in the pool.
364364
with a single underscore. This is to avoid collisions with the
365365
keyword configuration parameters of this method. If you need to
366366
pass such a parameter, use the ``parameters_`` parameter instead.
367-
These take precedence over parameters passed as ``parameters_``.
367+
Parameters passed as kwargs take precedence over those passed in
368+
``parameters_``.
368369
:type kwargs: typing.Any
369370

370371
:returns: the result of the ``result_transformer``

docs/source/async_api.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,8 @@ Closing a driver will immediately shut down all connections in the pool.
354354
with a single underscore. This is to avoid collisions with the
355355
keyword configuration parameters of this method. If you need to
356356
pass such a parameter, use the ``parameters_`` parameter instead.
357-
These take precedence over parameters passed as ``parameters_``.
357+
Parameters passed as kwargs take precedence over those passed in
358+
``parameters_``.
358359
:type kwargs: typing.Any
359360

360361
:returns: the result of the ``result_transformer``

src/neo4j/_async/driver.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -815,7 +815,8 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record::
815815
with a single underscore. This is to avoid collisions with the
816816
keyword configuration parameters of this method. If you need to
817817
pass such a parameter, use the ``parameters_`` parameter instead.
818-
These take precedence over parameters passed as ``parameters_``.
818+
Parameters passed as kwargs take precedence over those passed in
819+
``parameters_``.
819820
:type kwargs: typing.Any
820821
821822
:returns: the result of the ``result_transformer``

src/neo4j/_sync/driver.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -814,7 +814,8 @@ def example(driver: neo4j.Driver) -> neo4j.Record::
814814
with a single underscore. This is to avoid collisions with the
815815
keyword configuration parameters of this method. If you need to
816816
pass such a parameter, use the ``parameters_`` parameter instead.
817-
These take precedence over parameters passed as ``parameters_``.
817+
Parameters passed as kwargs take precedence over those passed in
818+
``parameters_``.
818819
:type kwargs: typing.Any
819820
820821
:returns: the result of the ``result_transformer``

0 commit comments

Comments
 (0)