Skip to content

Document severity values for the errors config #5465

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.

Sign up for GitHub

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

Closed
i098 wants to merge 1 commit into from
+3 −1
Closed

Document severity values for the errors config #5465

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion website/docs/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ Configure the severity for each kind of error that Pyrefly emits: `error`, `warn
Want full type-check squiggles in your editor? Run `pyrefly init` to create a `pyrefly.toml` (or update `pyproject.toml`).
:::

- Type: Table of [error code](./error-kinds.mdx) to boolean representing enabled status
- Type: Table of [error code](./error-kinds.mdx) to a severity (`"error"`, `"warn"`, `"info"`, `"hint"`, or `"ignore"`) or a boolean
- Default: `errors = {}`/`[errors]`
- Flag equivalent: `--error`, `--warn`, `--ignore`
- Equivalent configs:
Expand All @@ -886,6 +886,8 @@ Want full type-check squiggles in your editor? Run `pyrefly init` to create a `p
[`disable_error_code`](https://mypy.readthedocs.io/en/stable/config_file.html#confval-disable_error_code)
in mypy
- Notes:
- Setting `<error-code> = "<severity>"` (for example, `bad-return = "warn"`) shows the
error at that severity.
- Setting `<error-code> = true` means the error will be shown at default
severity (or severity `ERROR` if the error is off by default). Setting
`<error-code> = false` will disable the error for type checking.
Expand Down
Loading