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

Docs: Ruff formatter and conflicting isort rules ambiguity #8245

Closed
thernstig opened this issue Oct 26, 2023 · 1 comment · Fixed by #8257
Closed

Docs: Ruff formatter and conflicting isort rules ambiguity #8245

thernstig opened this issue Oct 26, 2023 · 1 comment · Fixed by #8257
Assignees
Labels
documentation Improvements or additions to documentation formatter Related to the formatter

Comments

@thernstig
Copy link

thernstig commented Oct 26, 2023

I have read all the docs now, and they are in general in great shape! So good job. There was only one section I could not grok, and I believe it could use some kind of improvement in its description.

From https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules

Similarly, we recommend disabling the following isort settings, which are incompatible with the formatter's treatment of import statements when set to non-default values:

Some of the settings are not able to be "disabled" per se. And there seems to be no action to take by a user if just using the formatter as-is, right?

Could the sentence be rephrased slightly?

@MichaReiser MichaReiser added documentation Improvements or additions to documentation formatter Related to the formatter labels Oct 26, 2023
@charliermarsh charliermarsh self-assigned this Oct 26, 2023
@charliermarsh
Copy link
Member

Good feedback -- will tweak today.

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 formatter Related to the formatter
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants