New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move boilerplate docs for 'if_generation_match' et al. out of method docstrings #460

Closed

tseaver opened this issue Jun 8, 2021 · 0 comments · Fixed by #464

Assignees

Labels

api: storage type: docs

Contributor

tseaver commented Jun 8, 2021

See also #455.

There are a ton of API-invoking methods which take if_generation_match, if_generation_not_match, etc. and have docstring entries for each of them which are both too verbose and too terse: they don't include / reference examples, and they are wordy. y preference, they would point instead to a narrative page (built from e.g. docs/conditional_arguments.rst) which would include comprehensive examples for them.

The text was updated successfully, but these errors were encountered:

tseaver added the type: docs label

product-auto-label bot added the api: storage label

tseaver mentioned this issue

Move boilerplate docs for 'timeout' and 'retry' out of method docstrings #455

Closed

tseaver self-assigned this

tseaver mentioned this issue

docs: streamline 'timeout' / 'retry' docs in docstrings #461

Merged

tseaver added a commit that referenced this issue


          docs: add narrative docs for conditional params

e974e0a

- 'if_genration_match'
- 'if_genration_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Toward #460.

tseaver added a commit that referenced this issue


          docs: streamline docstrings for conditional parmas

5098ef8

Link to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present)
for consistency).

Closes #460.

tseaver added a commit that referenced this issue


          docs: add narrative docs for conditional params

b4f7fe9

- 'if_genration_match'
- 'if_genration_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Toward #460.

tseaver added a commit that referenced this issue


          docs: streamline docstrings for conditional parmas

d8ad3ee

Link to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present)
for consistency.

Closes #460.

tseaver mentioned this issue

docs: streamline docstrings for conditional parmas #464

Merged

tseaver added a commit that referenced this issue


          docs: add narrative docs for conditional params

ead5533

- 'if_genration_match'
- 'if_genration_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Toward #460.

tseaver added a commit that referenced this issue


          docs: streamline docstrings for conditional parmas

1b2ef92

Link to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present)
for consistency.

Closes #460.

tseaver added a commit that referenced this issue


          docs: add narrative docs for conditional params

d676c0a

- 'if_genration_match'
- 'if_genration_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Toward #460.

tseaver added a commit that referenced this issue


          docs: streamline docstrings for conditional parmas

0d296b0

Link to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present)
for consistency.

Closes #460.

tseaver added a commit that referenced this issue


          docs: add narrative docs for conditional params

c502a92

- 'if_genration_match'
- 'if_genration_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Toward #460.

tseaver added a commit that referenced this issue


          docs: streamline docstrings for conditional parmas

7c04114

Link to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present)
for consistency.

Closes #460.

tseaver closed this as completed in #464

tseaver added a commit that referenced this issue


          docs: streamline docstrings for conditional parmas (#464)

Add narrative docs for conditional params:

- 'if_generation_match'
- 'if_generation_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Streamline docstrings for conditional params, linking to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present) for consistency.

Closes #460.

cojenco pushed a commit to cojenco/python-storage that referenced this issue


          docs: streamline docstrings for conditional parmas (googleapis#464)

506e883

Add narrative docs for conditional params:

- 'if_generation_match'
- 'if_generation_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Streamline docstrings for conditional params, linking to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present) for consistency.

Closes googleapis#460.

cojenco pushed a commit to cojenco/python-storage that referenced this issue


          docs: streamline docstrings for conditional parmas (googleapis#464)

04dd1e3

Add narrative docs for conditional params:

- 'if_generation_match'
- 'if_generation_not_match'
- 'if_metageneration_match'
- 'if_metageneration_not_match'

Streamline docstrings for conditional params, linking to new narrative docs.

Also, move 'timeout' argument to end (just before 'retry', if present) for consistency.

Closes googleapis#460.

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