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

Author: robsdedude

docs/source/api.rst

@@ -143,8 +143,13 @@ 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, close
+   :members: session, close, verify_connectivity
 
 
 .. _driver-configuration-ref:

neo4j/__init__.py

@@ -319,15 +319,24 @@ def verify_connectivity(self, **config):
         Use the exception to further understand the cause of the connectivity problem.
 
         Note: Even if this method throws an exception, the driver still need to be closed via close() to free up all resources.
+
+        .. note::
+            \\*\\*config is experimental may change in the future.
+
         """
         raise NotImplementedError
 
-    @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)