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

Update "format" Keyword in pyproject.toml to "output-format" #622

Open
Dridi-Hichem opened this issue Nov 2, 2023 · 0 comments
Open

Update "format" Keyword in pyproject.toml to "output-format" #622

Dridi-Hichem opened this issue Nov 2, 2023 · 0 comments

Comments

@Dridi-Hichem
Copy link
Contributor

Dridi-Hichem commented Nov 2, 2023

Issue:

The style in which violation messages are presented by Ruff is indicated by the keyword "format" inside pyproject.toml, as shown below:

[tool.ruff]
format = "grouped"

Previously, this configuration used to work in our template. However, recently, it causes a failure with the following error:

Cause: TOML parse error at line 126, column 10
        |
126  | format = "grouped"
        |
invalid type: string "grouped", expected struct FormatOptions

Upon investigating the documentation, I found that the correct keyword should be "output-format" instead of "format".

Proposal:

I suggest updating the configuration in pyproject.toml to reflect the correct keyword "output-format" as follows:

[tool.ruff]
output-format = "grouped"

This change should resolve the parsing error and align with the documentation's requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant