Adds a doc comment for new_batch_http_request

eljobe · eljobe · commit 56052ecfe29e · 2015-06-13T22:45:54.000-04:00
This comment doesn't actually show up in the generated epydoc, but it
does allow the "make docs" command to complete, and it is nice to have
the explanation of how to use the method in the source repository.

Without this change running "make docs" would have an error:
$&gt; make docs
cd docs; ./build
mkdir -p docs/dyn
python describe.py
Traceback (most recent call last):
  File "describe.py", line 388, in &lt;module&gt;
    document_api(api['name'], api['version'])
  File "describe.py", line 354, in document_api
    service, '%s_%s.' % (name, version), discovery, discovery)
  File "describe.py", line 320, in document_collection_recursive
    html = document_collection(resource, path, root_discovery,
                               discovery)
  File "describe.py", line 302, in document_collection
    params = method_params(doc)
  File "describe.py", line 192, in method_params
    doclines = doc.splitlines()
AttributeError: 'NoneType' object has no attribute 'splitlines'
make: *** [docs] Error 1
diff --git a/googleapiclient/discovery.py b/googleapiclient/discovery.py
@@ -956,6 +956,19 @@ def _add_basic_methods(self, resourceDesc, rootDesc, schema):
       batch_uri = '%s%s' % (
         rootDesc['rootUrl'], rootDesc.get('batchPath', 'batch'))
       def new_batch_http_request(callback=None):
+        """Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        """
         return BatchHttpRequest(callback=callback, batch_uri=batch_uri)
       self._set_dynamic_attr('new_batch_http_request', new_batch_http_request)
 
