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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can identify a custom checker by the link to the guidelines included in its
| C4759 | docstring-type-do-not-use-class | Docstring type is formatted incorrectly. Do not use `:class` in docstring type. | # pylint:disable=docstring-type-do-not-use-class | [Sphinx docstrings](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) | [Example](code_examples.md#docstring-type-do-not-use-class) |
| C4760 | no-typing-import-in-type-check | Do not import from typing inside of `if TYPE_CHECKING` block. You can import modules from typing outside of TYPE_CHECKING. | # pylint:disable=no-typing-import-in-type-check | No Link. | [Example](code_examples.md#no-typing-import-in-type-check) |
| C4761 | do-not-use-legacy-typing | Do not use legacy typing using comments. Python 2 is no longer supported, use Python 3.9+ type hints instead. | # pylint:disable=do-not-use-legacy-typing | No Link. | [Example](code_examples.md#do-not-use-legacy-typing) |
| C4762 | do-not-log-raised-errors | Do not log an exception that you re-raise "as-is" | # pylint:disable=do-not-log-raised-errors | No Link. | [Example](code_examples.md#do-not-log-raised-errors) |
| C4762 | do-not-log-raised-errors | 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.| # pylint:disable=do-not-log-raised-errors | No Link. | [Example](code_examples.md#do-not-log-raised-errors) |
| C4763 | do-not-import-asyncio | If asyncio.sleep() is being called and there is an azure core transport created, we should instead use the sleep function from the azure.core.pipeline.transport context instead. For other imports of asyncio, ignore this warning. | # pylint:disable=do-not-import-asyncio | No Link. | [Example](code_examples.md#do-not-import-asyncio) |
| C4765 | invalid-use-of-overload | Functions and their overloads must be either all async or all synchronous. | # pylint:disable=invalid-use-of-overload | No Link. | [Example](code_examples.md#invalid-use-of-overload) |
| C4766 | do-not-log-exceptions-if-not-debug | Do not log exceptions in levels other than debug, it can otherwise reveal sensitive information | # pylint:disable=do-not-log-exceptions-if-not-debug | [Logging sensitive info](https://azure.github.io/azure-sdk/python_implementation.html#python-logging-sensitive-info) | [Example](code_examples.md#do-not-log-exceptions-if-not-debug) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2730,9 +2730,9 @@ class DoNotLogErrorsEndUpRaising(BaseChecker):
name = "do-not-log-raised-errors"
priority = -1
msgs = {"C4762": (
"Do not log an exception that you re-raise 'as-is'",
"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.",
"do-not-log-raised-errors",
"Do not log an exception that you re-raise 'as-is'",
"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.",
),
}

Expand Down