Skip to content

Adds a doc comment for new_batch_http_request - #106

Merged
nathanielmanistaatgoogle merged 1 commit into
googleapis:masterfrom
eljobe:master
Jun 14, 2015
Merged

Adds a doc comment for new_batch_http_request#106
nathanielmanistaatgoogle merged 1 commit into
googleapis:masterfrom
eljobe:master

Conversation

@eljobe

@eljobe eljobe commented Jun 13, 2015

Copy link
Copy Markdown
Contributor

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.

@googlebot

googlebot commented Jun 13, 2015

Copy link
Copy Markdown

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project, in which case you'll need to sign a Contributor License Agreement (CLA).

馃摑 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

@googlebot googlebot added the cla: no This human has *not* signed the Contributor License Agreement. label Jun 13, 2015
@nathanielmanistaatgoogle

nathanielmanistaatgoogle commented Jun 13, 2015

Copy link
Copy Markdown
Contributor

If "make docs" is currently broken without this change, and this change fixes "make docs", I'd like that described in greater detail in the commit message?

@nathanielmanistaatgoogle

nathanielmanistaatgoogle commented Jun 13, 2015

Copy link
Copy Markdown
Contributor

Also please get the CLA signature business squared away. Is there something different about this contribution that was different about your other contribution, because we didn't see the bot object over there, did we?

@googlebot

googlebot commented Jun 13, 2015

Copy link
Copy Markdown

CLAs look good, thanks!

@googlebot googlebot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Jun 13, 2015
@eljobe

eljobe commented Jun 13, 2015

Copy link
Copy Markdown
Contributor Author

Added information to the git commit message and fixed the authorship of the commit.

nathanielmanistaatgoogle
nathanielmanistaatgoogle reviewed Jun 14, 2015
View reviewed changes
Comment thread googleapiclient/discovery.py

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@eljobe
Adds a doc comment for new_batch_http_request
56052ec 
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:
$> make docs
cd docs; ./build
mkdir -p docs/dyn
python describe.py
Traceback (most recent call last):
  File "describe.py", line 388, in <module>
    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
@eljobe eljobe closed this Jun 14, 2015
@eljobe eljobe reopened this Jun 14, 2015
nathanielmanistaatgoogle added a commit that referenced this pull request Jun 14, 2015
@nathanielmanistaatgoogle
Merge pull request #106 from eljobe/master
b1a707c 
Adds a doc comment for new_batch_http_request.
@nathanielmanistaatgoogle
nathanielmanistaatgoogle merged commit b1a707c into googleapis:master Jun 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@eljobe @googlebot @nathanielmanistaatgoogle