From b559ab0b466fdcddf6941df445a16e703e548a9a Mon Sep 17 00:00:00 2001 From: Bernie Hackett Date: Mon, 23 Feb 2015 16:19:27 -0800 Subject: [PATCH] PYTHON-835 - Consistent method signatures. --- doc/api/bson/binary.rst | 2 +- doc/api/bson/code.rst | 2 +- doc/api/bson/objectid.rst | 2 +- doc/api/pymongo/collection.rst | 14 +++++++------- doc/api/pymongo/mongo_client.rst | 2 +- doc/api/pymongo/mongo_replica_set_client.rst | 2 +- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/api/bson/binary.rst b/doc/api/bson/binary.rst index 65d24fec3..ab9d58f81 100644 --- a/doc/api/bson/binary.rst +++ b/doc/api/bson/binary.rst @@ -16,7 +16,7 @@ .. autodata:: MD5_SUBTYPE .. autodata:: USER_DEFINED_SUBTYPE - .. autoclass:: Binary(data[, subtype=BINARY_SUBTYPE]) + .. autoclass:: Binary(data, subtype=BINARY_SUBTYPE) :members: :show-inheritance: diff --git a/doc/api/bson/code.rst b/doc/api/bson/code.rst index 80b3b78b9..9050196d6 100644 --- a/doc/api/bson/code.rst +++ b/doc/api/bson/code.rst @@ -4,6 +4,6 @@ .. automodule:: bson.code :synopsis: Tools for representing JavaScript code - .. autoclass:: Code(code[, scope=None[, **kwargs]]) + .. autoclass:: Code(code, scope=None, **kwargs) :members: :show-inheritance: diff --git a/doc/api/bson/objectid.rst b/doc/api/bson/objectid.rst index ff97fe7f3..8f8ef066d 100644 --- a/doc/api/bson/objectid.rst +++ b/doc/api/bson/objectid.rst @@ -4,7 +4,7 @@ .. automodule:: bson.objectid :synopsis: Tools for working with MongoDB ObjectIds - .. autoclass:: bson.objectid.ObjectId([oid=None]) + .. autoclass:: bson.objectid.ObjectId(oid=None) :members: .. describe:: str(o) diff --git a/doc/api/pymongo/collection.rst b/doc/api/pymongo/collection.rst index 62417f930..88341e91d 100644 --- a/doc/api/pymongo/collection.rst +++ b/doc/api/pymongo/collection.rst @@ -16,7 +16,7 @@ .. autodata:: pymongo.cursor.TAILABLE_AWAIT .. autodata:: pymongo.cursor.EXHAUST - .. autoclass:: pymongo.collection.Collection(database, name[, create=False[, **kwargs]]) + .. autoclass:: pymongo.collection.Collection(database, name, create=False, **kwargs) .. describe:: c[name] || c.name @@ -41,8 +41,8 @@ .. automethod:: delete_one .. automethod:: delete_many .. automethod:: aggregate - .. automethod:: find([filter=None[, projection=None[, skip=0[, limit=0[, no_cursor_timeout=False[, cursor_type=NON_TAILABLE[, sort=None[, allow_partial_results=False[, oplog_replay=False[, modifiers=None[, manipulate=True]]]]]]]]]]]) - .. automethod:: find_one([filter_or_id=None[, *args[, **kwargs]]]) + .. automethod:: find(filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=NON_TAILABLE, sort=None, allow_partial_results=False, oplog_replay=False, modifiers=None, manipulate=True) + .. automethod:: find_one(filter_or_id=None, *args, **kwargs) .. automethod:: find_one_and_delete .. automethod:: find_one_and_replace(filter, replacement, projection=None, sort=None, return_document=ReturnDocument.Before, **kwargs) .. automethod:: find_one_and_update(filter, update, projection=None, sort=None, return_document=ReturnDocument.Before, **kwargs) @@ -63,9 +63,9 @@ .. automethod:: parallel_scan .. automethod:: initialize_unordered_bulk_op .. automethod:: initialize_ordered_bulk_op - .. automethod:: insert(doc_or_docs[, manipulate=True[, check_keys=True[, continue_on_error=False[, **kwargs]]]]) - .. automethod:: save(to_save[, manipulate=True[, check_keys=True[, **kwargs]]]) - .. automethod:: update(spec, document[, upsert=False[, manipulate=False[, multi=False[, check_keys=True[, **kwargs]]]]]) - .. automethod:: remove([spec_or_id=None[, multi=True[, **kwargs]]]) + .. automethod:: insert(doc_or_docs, manipulate=True, check_keys=True, continue_on_error=False, **kwargs) + .. automethod:: save(to_save, manipulate=True, check_keys=True, **kwargs) + .. automethod:: update(spec, document, upsert=False, manipulate=False, multi=False, check_keys=True, **kwargs) + .. automethod:: remove(spec_or_id=None, multi=True, **kwargs) .. automethod:: find_and_modify diff --git a/doc/api/pymongo/mongo_client.rst b/doc/api/pymongo/mongo_client.rst index 345404877..17eeeaf6d 100644 --- a/doc/api/pymongo/mongo_client.rst +++ b/doc/api/pymongo/mongo_client.rst @@ -4,7 +4,7 @@ .. automodule:: pymongo.mongo_client :synopsis: Tools for connecting to MongoDB - .. autoclass:: pymongo.mongo_client.MongoClient([host='localhost'[, port=27017[, max_pool_size=100[, document_class=dict[, tz_aware=False[, **kwargs]]]]]]) + .. autoclass:: pymongo.mongo_client.MongoClient(host='localhost', port=27017, max_pool_size=100, document_class=dict, tz_aware=False, **kwargs) .. automethod:: disconnect .. automethod:: close diff --git a/doc/api/pymongo/mongo_replica_set_client.rst b/doc/api/pymongo/mongo_replica_set_client.rst index 824609cd3..483f0f7c9 100644 --- a/doc/api/pymongo/mongo_replica_set_client.rst +++ b/doc/api/pymongo/mongo_replica_set_client.rst @@ -4,7 +4,7 @@ .. automodule:: pymongo.mongo_replica_set_client :synopsis: Tools for connecting to a MongoDB replica set - .. autoclass:: pymongo.mongo_replica_set_client.MongoReplicaSetClient([hosts_or_uri[, max_pool_size=100[, document_class=dict[, tz_aware=False[, **kwargs]]]]]) + .. autoclass:: pymongo.mongo_replica_set_client.MongoReplicaSetClient(hosts_or_uri, max_pool_size=100, document_class=dict, tz_aware=False, **kwargs) .. automethod:: disconnect .. automethod:: close