googleapis / googleapis/google-cloud-python

Make docstring follow PEP 257

Open
#15,692 3 comments 0 reactions 1 assignee Claimed by @gkevinzheng View on GitHub
api: bigquery priority: p3 type: cleanup type: docs
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
3d 4h
Merged PRs (30d)
122

Description

Coming from [this comment](https://github.com/googleapis/python-bigquery/pull/2333#discussion_r2560873839).

A lot of the docstrings in this repo are not properly following [PEP 257](https://peps.python.org/pep-0257/#multi-line-docstrings), leading to issue rendering in the documentation. For example, this [class property](https://github.com/googleapis/python-bigquery/blob/0529726400b1df4ade75cc3c9a829632ccb72eb8/google/cloud/bigquery/schema.py#L285) has a redundant type annotation, and it is not recognized by the [doc](https://docs.cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.SchemaField#google_cloud_bigquery_schema_SchemaField_field_type):

Image

We can audit the repo and update the docstrings to be PEP 257 compliant.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.