Skip to content
This repository was archived by the owner on Feb 26, 2026. It is now read-only.

docs: fix the docstring comment for LogEntry.severity#740

Closed
ymotongpoo wants to merge 2 commits into
googleapis:mainfrom
ymotongpoo:b739
Closed

docs: fix the docstring comment for LogEntry.severity#740
ymotongpoo wants to merge 2 commits into
googleapis:mainfrom
ymotongpoo:b739

Conversation

@ymotongpoo

Copy link
Copy Markdown
Contributor

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 #739 🦕

Yoshi Yamaguchi added 2 commits April 7, 2023 13:38
* change the type of LogEntry.severity from str
  to log_severity_pb2.LogSeverity
@ymotongpoo ymotongpoo requested review from a team April 7, 2023 04:44
@product-auto-label product-auto-label Bot added size: xs Pull request size is extra small. api: logging Issues related to the googleapis/python-logging API. labels Apr 7, 2023
@ymotongpoo ymotongpoo changed the title fix the docstring comment for LogEntry.severity docs: fix the docstring comment for LogEntry.severity Apr 7, 2023
@daniel-sanche

Copy link
Copy Markdown
Contributor

I believe this is an auto-generated file, so I'm not sure if this is the right place to make this change

@ymotongpoo

Copy link
Copy Markdown
Contributor Author

@daniel-sanche then which is the original? I could not other files that has this document comments in this repository.

@daniel-sanche

Copy link
Copy Markdown
Contributor

Sorry, I just checked again and while this file is similar to an autogenerated file, this one is not controlled by a template. My mistake

As discussed in #739 though, I believe the intention of the hand-written portion of the library is to use string representations for severity, so if we're able to fix the bug in #739, this change shouldn't be needed.

Thanks!

@product-auto-label product-auto-label Bot added the stale: old Pull request is old and needs attention. label May 7, 2023
@meredithslota

Copy link
Copy Markdown
Contributor

Based on comments in #739 which references #743, this is fixed in #744. Please reopen if this is not correct. Thanks!

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

Labels

api: logging Issues related to the googleapis/python-logging API. size: xs Pull request size is extra small. stale: old Pull request is old and needs attention.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The docstring comment to describe type of severity field in LogEntry is not up to date

4 participants