Skip to content

Clarify parameter precedence in execute_query docs #919

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

Merged
merged 2 commits into from
Apr 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
3 changes: 2 additions & 1 deletion docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
3 changes: 2 additions & 1 deletion docs/source/async_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
3 changes: 2 additions & 1 deletion src/neo4j/_async/driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
3 changes: 2 additions & 1 deletion src/neo4j/_sync/driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down