Skip to content
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.

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

Already on GitHub? Sign in to your account

docs: Describe code sample more specifically #660

Merged
merged 1 commit into from Dec 10, 2021

Conversation

cbonnie
Copy link
Contributor

@cbonnie cbonnie commented Dec 7, 2021

docs: This is just a simple PR to better describe what the code is doing in the comments.

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • [ x] Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • [ x] Ensure the tests and linter pass
  • [ x] Code coverage does not decrease (if any source code was changed)
  • [ x] Appropriate docs were updated (if necessary)

Fixes #661 馃

@cbonnie cbonnie requested review from a team as code owners December 7, 2021 17:29
@cbonnie cbonnie requested a review from kurtisvg December 7, 2021 17:29
@product-auto-label product-auto-label bot added api: storage Issues related to the googleapis/python-storage API. samples Issues that are directly related to samples. labels Dec 7, 2021
@cbonnie cbonnie changed the title Describe code sample more specifically docs: Describe code sample more specifically Dec 7, 2021
docs: This is just a simple PR to better describe what the code is doing in the comments.
@cojenco cojenco added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 7, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 7, 2021
@cojenco
Copy link
Contributor

cojenco commented Dec 7, 2021

@cbonnie Thanks for updating the code sample description to be more specific.

Looking at where the sample is linked on c.g.c alongside other languages, would it make more sense to instead add comments/variables location="us" and storage_class="COLDLINE" so that the variables are shown to be optional and configurable. WDYT?

@leahecole leahecole merged commit 0459cb4 into googleapis:main Dec 10, 2021
@leahecole
Copy link
Contributor

i love PRs like this. Teeny change to make something more helpful!

@cbonnie
Copy link
Contributor Author

cbonnie commented Dec 10, 2021

@cojenco Hm, not quite sure I understand - could you show me what the change would look like?

@leahecole Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/python-storage API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More specifically describe code sample in comment block
5 participants