Merge pull request djc#279 from giftig/master

djc · djc · commit 0e0ea622d75c · 2016-04-08T15:18:20.000+02:00
Make Client.update_doc documentation clearer
diff --git a/couchdb/client.py b/couchdb/client.py
@@ -1006,7 +1006,10 @@ def update_doc(self, name, docid=None, **options):
         :param name: the name of the update handler function in the format
                      ``designdoc/updatename``.
         :param docid: optional ID of a document to pass to the update handler.
-        :param options: optional query string parameters.
+        :param options: additional (optional) params to pass to the underlying
+                        http resource handler, including ``headers``, ``body``,
+                        and ```path```. Other arguments will be treated as
+                        query string params. See :class:`couchdb.http.Resource`
         :return: (headers, body) tuple, where headers is a dict of headers
                  returned from the list function and body is a readable
                  file-like instance
