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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): remove get_default_handler call from samples/snippets/handler.py #421

Merged
merged 2 commits into from
Oct 19, 2021

Conversation

csudcy
Copy link
Contributor

@csudcy csudcy commented Oct 14, 2021

Since client.setup_logging() calls self.get_default_handler(**kw) internally, I don't think the call here is needed (e.g. it's not showing the users how to do something else).

Apologies, I'm currently doing this through the Github UI; I don't see how this could break tests (but that's the point of having tests) but if I need to run the tests/linter/coverage, please let me know.

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:

  • 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
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #420

Since `client.setup_logging()` calls `self.get_default_handler(**kw)` internally, the call here is not needed.
@csudcy csudcy requested a review from a team as a code owner October 14, 2021 08:40
@csudcy csudcy requested a review from parthea October 14, 2021 08:40
@product-auto-label product-auto-label bot added the api: logging Issues related to the googleapis/python-logging API. label Oct 14, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 14, 2021
@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Oct 14, 2021
@csudcy
Copy link
Contributor Author

csudcy commented Oct 14, 2021

Dangit, didn't see the conventionalcommits.org requirement in the contributing docs; can't work out how to change commit messages through Github UI so will get on the command line later to change it.

@parthea parthea added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Oct 14, 2021
@yoshi-kokoro yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Oct 14, 2021
@daniel-sanche daniel-sanche changed the title Remove get_default_handler call from samples/snippets/handler.py chore(docs): remove get_default_handler call from samples/snippets/handler.py Oct 14, 2021
@daniel-sanche
Copy link
Contributor

daniel-sanche commented Oct 14, 2021

Don't worry about changing the commits. PRs are squashed based on PR name, so as long as the name follows conventions, it'll be fine. The Cloud Build and 3.10 tests are also expected to fail now, as we're in the process of adding new tests

As for the change itself, It makes sense. We may want to make a different sample showing users how to access the default_handler, but we can address that in the upcoming v3.0.0 docs update

Thanks for opening this!

@daniel-sanche daniel-sanche added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 14, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 14, 2021
@parthea parthea added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Oct 16, 2021
@yoshi-kokoro yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Oct 16, 2021
@daniel-sanche daniel-sanche added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 18, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 18, 2021
@daniel-sanche daniel-sanche added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 19, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 19, 2021
Copy link
Contributor

@leahecole leahecole left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM if tests are passing

@daniel-sanche
Copy link
Contributor

It looks like they only failing tests are Cloud Build (not fully implemented) and Python 3.10 (known issue, still rolling out)

@daniel-sanche daniel-sanche merged commit 14ac48a into googleapis:main Oct 19, 2021
@csudcy csudcy deleted the update-docs branch October 21, 2021 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: logging Issues related to the googleapis/python-logging API. cla: yes This human has signed the Contributor License Agreement. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unnecessary call to client.get_default_handler() in samples/snippets/handler.py
5 participants