Skip to content

fixing documentation #10433

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fixing documentation #10433

wants to merge 1 commit into from

Conversation

l0lawrence
Copy link
Member

No description provided.

@Copilot Copilot AI review requested due to automatic review settings April 23, 2025 20:50
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation for the "do-not-log-raised-errors" rule by clarifying the guideline message in both the checker implementation and the README.

  • Updated error message text in the checker to guide developers either to remove the logging or not to re-raise the exception "as-is".
  • Synchronized documentation in the README with the updated error message.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
tools/pylint-extensions/azure-pylint-guidelines-checker/pylint_guidelines_checker.py Clarified error message text in the rule implementation.
tools/pylint-extensions/azure-pylint-guidelines-checker/README.md Updated the documentation to match the revised error message.
Comments suppressed due to low confidence (2)

tools/pylint-extensions/azure-pylint-guidelines-checker/README.md:58

  • Ensure the documentation message in the README is updated to match the revised error message in the checker implementation.
Do not log an exception that you re-raise "as-is". Remove the log of the exception or don't raise the exception as-is.

tools/pylint-extensions/azure-pylint-guidelines-checker/pylint_guidelines_checker.py:2733

  • The updated error message text provides clearer guidance; please ensure that this level of detail is consistent with other similar rules in the codebase.
Do not log an exception that you re-raise 'as-is'. Remove the log of the exception or don't raise the exception as-is.

Copy link

Hi @l0lawrence. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

@github-actions github-actions bot added the no-recent-activity There has been no recent activity on this issue. label Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-recent-activity There has been no recent activity on this issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant