Skip to content

Commit 761074c

Browse files
authored
API docs: Fix execute_query parameter names (#1087)
Trailing underscores of parameters to `Driver.execute_query` were not being properly displayed.
1 parent 735dd96 commit 761074c

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

docs/source/api.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -246,18 +246,18 @@ Closing a driver will immediately shut down all connections in the pool.
246246
assert isinstance(count, int)
247247
return count
248248

249-
:param query_:
249+
:param query:
250250
Cypher query to execute.
251251
Use a :class:`.Query` object to pass a query with additional
252252
transaction configuration.
253-
:type query_: typing.LiteralString | Query
254-
:param parameters_: parameters to use in the query
255-
:type parameters_: typing.Dict[str, typing.Any] | None
256-
:param routing_:
253+
:type query: typing.LiteralString | Query
254+
:param parameters\_: parameters to use in the query
255+
:type parameters\_: typing.Dict[str, typing.Any] | None
256+
:param routing\_:
257257
Whether to route the query to a reader (follower/read replica) or
258258
a writer (leader) in the cluster. Default is to route to a writer.
259-
:type routing_: RoutingControl
260-
:param database_:
259+
:type routing\_: RoutingControl
260+
:param database\_:
261261
Database to execute the query against.
262262

263263
None (default) uses the database configured on the server side.
@@ -268,8 +268,8 @@ Closing a driver will immediately shut down all connections in the pool.
268268
as it will not have to resolve the default database first.
269269

270270
See also the Session config :ref:`database-ref`.
271-
:type database_: str | None
272-
:param impersonated_user_:
271+
:type database\_: str | None
272+
:param impersonated_user\_:
273273
Name of the user to impersonate.
274274

275275
This means that all query will be executed in the security context
@@ -278,15 +278,15 @@ Closing a driver will immediately shut down all connections in the pool.
278278
permissions.
279279

280280
See also the Session config :ref:`impersonated-user-ref`.
281-
:type impersonated_user_: str | None
282-
:param auth_:
281+
:type impersonated_user\_: str | None
282+
:param auth\_:
283283
Authentication information to use for this query.
284284

285285
By default, the driver configuration is used.
286286

287287
See also the Session config :ref:`session-auth-ref`.
288-
:type auth_: typing.Tuple[typing.Any, typing.Any] | Auth | None
289-
:param result_transformer_:
288+
:type auth\_: typing.Tuple[typing.Any, typing.Any] | Auth | None
289+
:param result_transformer\_:
290290
A function that gets passed the :class:`neo4j.Result` object
291291
resulting from the query and converts it to a different type. The
292292
result of the transformer function is returned by this method.
@@ -346,9 +346,9 @@ Closing a driver will immediately shut down all connections in the pool.
346346
result_transformer_=transformer
347347
)
348348

349-
:type result_transformer_:
349+
:type result_transformer\_:
350350
typing.Callable[[Result], T]
351-
:param bookmark_manager_:
351+
:param bookmark_manager\_:
352352
Specify a bookmark manager to use.
353353

354354
If present, the bookmark manager is used to keep the query causally
@@ -357,7 +357,7 @@ Closing a driver will immediately shut down all connections in the pool.
357357
Defaults to the driver's :attr:`.execute_query_bookmark_manager`.
358358

359359
Pass :data:`None` to disable causal consistency.
360-
:type bookmark_manager_: BookmarkManager | None
360+
:type bookmark_manager\_: BookmarkManager | None
361361
:param kwargs: additional keyword parameters. None of these can end
362362
with a single underscore. This is to avoid collisions with the
363363
keyword configuration parameters of this method. If you need to

docs/source/async_api.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -233,18 +233,18 @@ Closing a driver will immediately shut down all connections in the pool.
233233
assert isinstance(count, int)
234234
return count
235235

236-
:param query_:
236+
:param query:
237237
Cypher query to execute.
238238
Use a :class:`.Query` object to pass a query with additional
239239
transaction configuration.
240-
:type query_: typing.LiteralString | Query
241-
:param parameters_: parameters to use in the query
242-
:type parameters_: typing.Dict[str, typing.Any] | None
243-
:param routing_:
240+
:type query: typing.LiteralString | Query
241+
:param parameters\_: parameters to use in the query
242+
:type parameters\_: typing.Dict[str, typing.Any] | None
243+
:param routing\_:
244244
Whether to route the query to a reader (follower/read replica) or
245245
a writer (leader) in the cluster. Default is to route to a writer.
246-
:type routing_: RoutingControl
247-
:param database_:
246+
:type routing\_: RoutingControl
247+
:param database\_:
248248
Database to execute the query against.
249249

250250
None (default) uses the database configured on the server side.
@@ -255,8 +255,8 @@ Closing a driver will immediately shut down all connections in the pool.
255255
as it will not have to resolve the default database first.
256256

257257
See also the Session config :ref:`database-ref`.
258-
:type database_: str | None
259-
:param impersonated_user_:
258+
:type database\_: str | None
259+
:param impersonated_user\_:
260260
Name of the user to impersonate.
261261

262262
This means that all query will be executed in the security context
@@ -265,15 +265,15 @@ Closing a driver will immediately shut down all connections in the pool.
265265
permissions.
266266

267267
See also the Session config :ref:`impersonated-user-ref`.
268-
:type impersonated_user_: str | None
269-
:param auth_:
268+
:type impersonated_user\_: str | None
269+
:param auth\_:
270270
Authentication information to use for this query.
271271

272272
By default, the driver configuration is used.
273273

274274
See also the Session config :ref:`session-auth-ref`.
275-
:type auth_: typing.Tuple[typing.Any, typing.Any] | Auth | None
276-
:param result_transformer_:
275+
:type auth\_: typing.Tuple[typing.Any, typing.Any] | Auth | None
276+
:param result_transformer\_:
277277
A function that gets passed the :class:`neo4j.AsyncResult` object
278278
resulting from the query and converts it to a different type. The
279279
result of the transformer function is returned by this method.
@@ -333,9 +333,9 @@ Closing a driver will immediately shut down all connections in the pool.
333333
result_transformer_=transformer
334334
)
335335

336-
:type result_transformer_:
336+
:type result_transformer\_:
337337
typing.Callable[[AsyncResult], typing.Awaitable[T]]
338-
:param bookmark_manager_:
338+
:param bookmark_manager\_:
339339
Specify a bookmark manager to use.
340340

341341
If present, the bookmark manager is used to keep the query causally
@@ -344,7 +344,7 @@ Closing a driver will immediately shut down all connections in the pool.
344344
Defaults to the driver's :attr:`.execute_query_bookmark_manager`.
345345

346346
Pass :data:`None` to disable causal consistency.
347-
:type bookmark_manager_: AsyncBookmarkManager | BookmarkManager | None
347+
:type bookmark_manager\_: AsyncBookmarkManager | BookmarkManager | None
348348
:param kwargs: additional keyword parameters. None of these can end
349349
with a single underscore. This is to avoid collisions with the
350350
keyword configuration parameters of this method. If you need to

0 commit comments

Comments
 (0)