Skip to content

Fix typo and unnecessary word in docstring #1691

@rariyama

Description

@rariyama

Thanks for stopping by to let us know something could be better!

PLEASE READ: If you have a support contract with Google, please create an issue in the support console instead of filing on GitHub. This will ensure a timely response.

Please run down the following list and make sure you've tried the usual "quick fixes":

If you are still having issues, please be sure to include as much information as possible:

Environment details

  • OS type and version:
  • Python version: python --version
  • pip version: pip --version
  • google-api-python-client version: pip show google-api-python-client

Steps to reproduce

  1. You can access typo in docstring.
    a https://github.com/googleapis/google-api-python-client/blob/main/googleapiclient/_helpers.py#L45
    b https://github.com/googleapis/google-api-python-client/blob/main/googleapiclient/discovery.py#L331
  2. You can also access unnecessary word in docstring.
    a https://github.com/googleapis/google-api-python-client/blob/main/googleapiclient/_helpers.py#L97
    b https://github.com/googleapis/google-api-python-client/blob/main/googleapiclient/_helpers.py#L105

Code example

- 1.a def fn(pos1, *, kwonly1=None, kwonly1=None): -> def fn(pos1, *, kwonly1=None, kwonly2=None):
- 1.b attemnting -> attempting
- 2.a parameters after the this index must be -> parameters after this index must be
- 2.b TypeError: if a key-word only argument is provided as a positional -> TypeError: if a keyword-only argument is provided as a positional
    - Since keyword-only is already used in this docstring as an adjective, it's better to modify to it for consistency.

Stack trace

irrelevant

Making sure to follow these steps will guarantee the quickest resolution possible.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    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