Skip to content

Commit

Permalink
Add a private API warning in the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke Sneeringer committed Mar 30, 2017
1 parent 017e5ca commit 581d7ed
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions docs/google-cloud-auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,14 +298,23 @@ you add the correct scopes for the APIs you want to access:
Advanced Customization
======================

Though the ``google-cloud-python`` library defaults to using `google-auth`_
to sign requests and ``httplib2`` for sending requests,
it is not a strict requirement.
.. warning::

The google-cloud developers want to improve our HTTP handling to

This comment has been minimized.

Copy link
@dhermes

dhermes Mar 30, 2017

Contributor

s/google-cloud/google-cloud-python?

This comment has been minimized.

Copy link
@lukesneeringer

lukesneeringer Mar 30, 2017

Contributor

I could go either way. I originally wrote google-cloud-python and it felt wrong.

This comment has been minimized.

Copy link
@dhermes

dhermes Mar 30, 2017

Contributor

google-cloud isn't specific enough, like, it could even mean the devs of the gcloud CLI. (Though context makes it specific enough, i.e. it comes within the google-cloud-python docset)

This comment has been minimized.

Copy link
@lukesneeringer

lukesneeringer Mar 30, 2017

Contributor

How about just "The developers"?

This comment has been minimized.

Copy link
@dhermes

dhermes Mar 30, 2017

Contributor

👍

support more situations more easily, and use current tooling.

In order to allow this, this particular mechanism may have to be altered
in a backwards-compatible way. Therefore, the following section should
be considered "private API" that is subject to change.

Though the ``google-cloud-python`` library uses `google-auth`_ to sign
requests and ``httplib2`` for sending requests.

This comment has been minimized.

Copy link
@dhermes

dhermes Mar 30, 2017

Contributor

This is now a sentence fragment, suggest dropping "Though" at the beginning?


.. _google-auth: http://google-auth.readthedocs.io/en/stable/

The :class:`Client <google.cloud.client.Client>` constructor accepts an optional
``_http`` argument in place of a ``credentials`` object.
This is not a stirct requirement:

This comment has been minimized.

Copy link
@dhermes

dhermes Mar 30, 2017

Contributor

s/stirct/strict

The :class:`Client <google.cloud.client.Client>` constructor accepts an
optional ``_http`` argument in place of a ``credentials`` object.
If passed, all HTTP requests made by the client will use your
custom HTTP object.

Expand Down

0 comments on commit 581d7ed

Please sign in to comment.