Skip to content

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

Description

@sashko1988

"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.

Activity

  1. charliermarsh commented on Jul 16, 2024

    @charliermarsh
    Member

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

  2. sashko1988 commented on Jul 16, 2024

    @sashko1988
    ContributorAuthor

    @charliermarsh would love to!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to public-facing documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions