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

Settings section of documentation has incorrect default value for output-format #12350

Closed
sashko1988 opened this issue Jul 16, 2024 · 2 comments · Fixed by #12409
Closed

Settings section of documentation has incorrect default value for output-format #12350

sashko1988 opened this issue Jul 16, 2024 · 2 comments · Fixed by #12409
Labels
documentation Improvements or additions to documentation

Comments

@sashko1988
Copy link
Contributor

"documentation", "default settings", "output-format", 0.5.2 version

Settings section for toml files still shows concise as default (https://docs.astral.sh/ruff/settings/#output-format):

The style in which violation messages should be formatted: "full" (shows source), "concise" (default), "grouped" (group messages by file), "json" (machine-readable), "junit" (machine-readable XML), "github" (GitHub Actions annotations), "gitlab" (GitLab CI code quality report), "pylint" (Pylint text format) or "azure" (Azure Pipeline logging commands).

Default value: "concise"

While cli outputs full as a default:

--output-format <OUTPUT_FORMAT> Output serialization format for violations. The default serialization format is "full"

And ruff actually uses full if a user doesn't specify it.

@charliermarsh
Copy link
Member

Thank you -- it looks like we forgot to update crates/ruff_workspace/src/options.rs. Are you interested in submitting a PR?

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jul 16, 2024
@sashko1988
Copy link
Contributor Author

@charliermarsh would love to!

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

Successfully merging a pull request may close this issue.

2 participants