Fixing some docstrings that did not render as intended #1345
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
|
|
||
| Checks environment in order of precedence: | ||
|
|
||
| * Google App Engine (production and testing) | ||
| * Environment variable GOOGLE_APPLICATION_CREDENTIALS pointing to | ||
| * Environment variable ``GOOGLE_APPLICATION_CREDENTIALS`` pointing to |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
dhermes
force-pushed
the
some-docs-cleanup
branch
from
fa6429b
to
51c7b41
Compare
| @@ -12,7 +12,7 @@ | |||
| # See the License for the specific language governing permissions and | |||
| # limitations under the License. | |||
|
|
|||
| """Custom exceptions for gcloud.storage package. | |||
| """Custom exceptions for :mod:`gcloud` package. | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
@tseaver PTAL I added |
|
While I understand the desire for "pretty" history, this PR is a case where rebasing to squash commits interferes with review: the small changes you just introduced would've been easier to re-review as separate commits. LGTM |
|
Gotcher. In |
Sphinx successfully rendered some docstrings that did things different than intended. Found via visual inspection of a few of the rendered files (more to come). Also - using names of basic types (`dict` instead of `dictionary`, `bool` instead of `boolean`) since Sphinx recognizes them. - fixing some broken Sphinx links - fixing some broken URLs (404, docs moved) - adding formatting to unformatted text - renaming doc with underscores to use hyphen - removing an accidentally public var that was documented (eklass -> _eklass) - referring to `gcloud` module instead of `gcloud.storage` in `gcloud.exceptions`
dhermes
force-pushed
the
some-docs-cleanup
branch
from
51c7b41
to
c684c29
Compare
dhermes
added a commit
that referenced
this pull request
Jan 7, 2016
Fixing some docstrings that did not render as intended
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sphinx successfully rendered some docstrings that did things
different than intended. Found via visual inspection of a few
of the rendered files (more to come). Also
dictinstead ofdictionary,boolinstead ofboolean) since Sphinx recognizes them.