Skip to content

Fixing some docstrings that did not render as intended - #1345

Merged
dhermes merged 1 commit into
googleapis:masterfrom
dhermes:some-docs-cleanup
Jan 7, 2016
Merged

Fixing some docstrings that did not render as intended#1345
dhermes merged 1 commit into
googleapis:masterfrom
dhermes:some-docs-cleanup

Conversation

@dhermes

Copy link
Copy Markdown
Contributor

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)

@dhermesdhermes added the docs label Jan 4, 2016
@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Jan 4, 2016
@dhermesdhermes mentioned this pull request Jan 6, 2016
Comment threadgcloud/credentials.py Outdated

This comment was marked as spam.

This comment was marked as spam.

Comment threadgcloud/exceptions.py

This comment was marked as spam.

@dhermes

Copy link
Copy Markdown
ContributorAuthor

@tseaver PTAL I added :envvar: and rebased

@tseaver

Copy link
Copy Markdown
Contributor

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

@dhermes

Copy link
Copy Markdown
ContributorAuthor

Gotcher. In oauth2client, the maintainers usually ask for squashing after the fact. I should/can/will start doing that in PRs.

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 added a commit that referenced this pull request Jan 7, 2016
Fixing some docstrings that did not render as intended
@dhermes
dhermes merged commit 5fc0150 into googleapis:masterJan 7, 2016
@dhermes
dhermes deleted the some-docs-cleanup branch January 7, 2016 23:03
@dhermesdhermes mentioned this pull request Jan 25, 2016
parthea pushed a commit that referenced this pull request Mar 9, 2026
Source-Link: googleapis/synthtool@71a7297
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:e8dcfd7cbfd8beac3a3ff8d3f3185287ea0625d859168cc80faccfc9a7a00455
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: cojenco <cathyo@google.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dhermes@tseaver@googlebot