Skip to content

Commit 98dfae9

Browse files
authored
[4.4] API docs: be more explicit about driver factory parameters (#884)
* API docs: cannot combine +s/+ssc schemes with some settings * API docs: be more explicit about driver factory parameters
1 parent 7bd036b commit 98dfae9

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

docs/source/api.rst

+4
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,8 @@ connection can be used to perform database related work.
262262
-------------
263263
Specify whether to use an encrypted connection between the driver and server.
264264

265+
This setting is only available for URI schemes ``bolt://`` and ``neo4j://`` (:ref:`uri-ref`).
266+
265267
:Type: ``bool``
266268
:Default: ``False``
267269

@@ -346,6 +348,8 @@ For example:
346348
---------
347349
Specify how to determine the authenticity of encryption certificates provided by the Neo4j instance on connection.
348350

351+
This setting is only available for URI schemes ``bolt://`` and ``neo4j://`` (:ref:`uri-ref`).
352+
349353
This setting does not have any effect if ``encrypted`` is set to ``False``.
350354

351355
:Type: ``neo4j.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES``, ``neo4j.TRUST_ALL_CERTIFICATES``

neo4j/__init__.py

+9-3
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,15 @@ class GraphDatabase:
126126
def driver(cls, uri, *, auth=None, **config):
127127
"""Create a driver.
128128
129-
:param uri: the connection URI for the driver, see :ref:`uri-ref` for available URIs.
130-
:param auth: the authentication details, see :ref:`auth-ref` for available authentication details.
131-
:param config: driver configuration key-word arguments, see :ref:`driver-configuration-ref` for available key-word arguments.
129+
:param uri: the connection URI for the driver,
130+
see :ref:`uri-ref` for available URIs.
131+
:type uri: str
132+
:param auth: the authentication details,
133+
see :ref:`auth-ref` for available authentication details.
134+
:type auth: None or typing.Tuple[typing.Any, typing.Any] or Auth
135+
:param config: driver configuration key-word arguments,
136+
see :ref:`driver-configuration-ref` for available
137+
key-word arguments.
132138
133139
:return: :ref:`neo4j-driver-ref` or :ref:`bolt-driver-ref`
134140
"""

0 commit comments

Comments
 (0)