Skip to content

Changing comment style from Google to Sphinx #8

Closed

Description

@fatcat2

The purpose of this issue is to track the change from Google-style comments to Sphinx-style comments.

Activity

  1. self-assigned this
    on Jul 8, 2019
  2. added
    type: docsImprovement to the documentation for an API.
    priority: p2Moderately-important priority. Fix may not be included in next release.
    priority: p1Important issue which blocks shipping the next release. Will be fixed prior to next release.
    and removed
    priority: p2Moderately-important priority. Fix may not be included in next release.
    on Feb 8, 2021
  3. self-assigned this
    on Feb 8, 2021
  4. added
    type: processA process-related concern. May include testing, release, or the like.
    and removed
    type: docsImprovement to the documentation for an API.
    on Feb 16, 2021
  5. shubha-rajan commented on Feb 19, 2021

    @shubha-rajan
    Contributor

    So It looks like these are already Sphinx style docstrings. Our other repos, like python-storage also seem to be using Sphinx. Gonna close this one since it looks like it's already done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

priority: p1Important issue which blocks shipping the next release. Will be fixed prior to next release.type: processA process-related concern. May include testing, release, or the like.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions