Document Driver.verify_connectivity + add experimental notes (#668)

Author: robsdedude

docs/source/api.rst

@@ -144,6 +144,11 @@ This object holds the details required to establish connections with a Neo4j dat
 :class:`neo4j.Driver` objects hold a connection pool from which :class:`neo4j.Session` objects can borrow connections.
 Closing a driver will immediately shut down all connections in the pool.
 
+.. note::
+    Driver objects only open connections and pool them as needed. To verify that
+    the driver is able to communicate with the database without executing any
+    query, use :meth:`neo4j.Driver.verify_connectivity`.
+
 .. autoclass:: neo4j.Driver()
    :members: session, encrypted, close, verify_connectivity, get_server_info
 

docs/source/async_api.rst

@@ -127,6 +127,11 @@ This object holds the details required to establish connections with a Neo4j dat
 :class:`neo4j.AsyncDriver` objects hold a connection pool from which :class:`neo4j.AsyncSession` objects can borrow connections.
 Closing a driver will immediately shut down all connections in the pool.
 
+.. note::
+    Driver objects only open connections and pool them as needed. To verify that
+    the driver is able to communicate with the database without executing any
+    query, use :meth:`neo4j.AsyncDriver.verify_connectivity`.
+
 .. autoclass:: neo4j.AsyncDriver()
    :members: session, encrypted, close, verify_connectivity, get_server_info
 

neo4j/_async/driver.py

@@ -307,7 +307,7 @@ async def verify_connectivity(self, **config):
             connectivity problem.
 
         .. versionchanged:: 5.0 the config parameters will be removed in
-            version 6 0. It has no effect starting in version 5.0.
+            version 6 0. It has no effect starting with version 5.0.
         """
         if config:
             deprecation_warn(
@@ -342,12 +342,16 @@ async def get_server_info(self):
         async with self.session() as session:
             return await session._get_server_info()
 
-    @experimental("Feature support query, based on Bolt Protocol Version and Neo4j Server Version will change in the future.")
+    @experimental("Feature support query, based on Bolt protocol version and Neo4j server version will change in the future.")
     async def supports_multi_db(self):
         """ Check if the server or cluster supports multi-databases.
 
         :return: Returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.
         :rtype: bool
+
+        .. note::
+            Feature support query, based on Bolt Protocol Version and Neo4j
+            server version will change in the future.
         """
         async with self.session() as session:
             await session._connect(READ_ACCESS)

neo4j/_sync/driver.py

@@ -307,7 +307,7 @@ def verify_connectivity(self, **config):
             connectivity problem.
 
         .. versionchanged:: 5.0 the config parameters will be removed in
-            version 6 0. It has no effect starting in version 5.0.
+            version 6 0. It has no effect starting with version 5.0.
         """
         if config:
             deprecation_warn(
@@ -342,12 +342,16 @@ def get_server_info(self):
         with self.session() as session:
             return session._get_server_info()
 
-    @experimental("Feature support query, based on Bolt Protocol Version and Neo4j Server Version will change in the future.")
+    @experimental("Feature support query, based on Bolt protocol version and Neo4j server version will change in the future.")
     def supports_multi_db(self):
         """ Check if the server or cluster supports multi-databases.
 
         :return: Returns true if the server or cluster the driver connects to supports multi-databases, otherwise false.
         :rtype: bool
+
+        .. note::
+            Feature support query, based on Bolt Protocol Version and Neo4j
+            server version will change in the future.
         """
         with self.session() as session:
             session._connect(READ_ACCESS)