FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix docstrings to conform to reStructuredText format · Issue #386 · googleapis/python-spanner · GitHub

This repository was archived by the owner on Jun 8, 2026. It is now read-only.
/ python-spanner Public archive
This repository was archived by the owner on Jun 8, 2026. It is now read-only.

fix docstrings to conform to reStructuredText format #386

Description

Currently there are some files like https://github.com/googleapis/python-spanner/blob/master/google/cloud/spanner_v1/session.py which has docstrings that do not conform to Google Docstrings -> reStructuredText format.

For example:

:raises: :exc:`ValueError` if :attr:`session_id` is already set.

should be

:raises ValueError: if :attr:`session_id` is already set.

and

:raises: ValueError: if :attr:`session_id` is not already set.

should be

:raises ValueError: if :attr:`session_id` is not already set.

Please close this issue once there aren't any more of these malformed docstrings in this repository.

Activity

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

Metadata

Metadata

Assignees

Labels

api: spannerIssues related to the googleapis/python-spanner API.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


    Back | FazBrowse Home | New Git URL