From 6afcf14f4fb4d0c9f760cdb0cfe4528d179cf944 Mon Sep 17 00:00:00 2001 From: Felipe Rodrigues Date: Fri, 24 Aug 2018 14:09:17 -0300 Subject: [PATCH] Add class docstring to MongoClient (#372) --- doc/contributors.rst | 1 + pymongo/mongo_client.py | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/doc/contributors.rst b/doc/contributors.rst index 2957c73bd..649f2e1bf 100644 --- a/doc/contributors.rst +++ b/doc/contributors.rst @@ -84,3 +84,4 @@ The following is a list of people who have contributed to - TaoBeier(tao12345666333) - Jagrut Trivedi(Jagrut) - Shrey Batra(shreybatra) +- Felipe Rodrigues(fbidu) diff --git a/pymongo/mongo_client.py b/pymongo/mongo_client.py index d26a398f9..d1941a60a 100644 --- a/pymongo/mongo_client.py +++ b/pymongo/mongo_client.py @@ -75,6 +75,15 @@ from pymongo.write_concern import DEFAULT_WRITE_CONCERN class MongoClient(common.BaseObject): + """ + A client-side representation of a MongoDB cluster. + + Instances can represent either a standalone MongoDB server, a replica + set, or a sharded cluster. Instances of this class are responsible for + maintaining up-to-date state of the cluster, and possibly cache + resources related to this, including background threads for monitoring, + and connection pools. + """ HOST = "localhost" PORT = 27017 # Define order to retrieve options from ClientOptions for __repr__.