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.

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

Jump to bottom

Formatter: Documentation #7235

Closed
MichaReiser opened this issue Sep 8, 2023 · 2 comments · Fixed by #7732
Closed

Formatter: Documentation #7235

MichaReiser opened this issue Sep 8, 2023 · 2 comments · Fixed by #7732
Assignees
@charliermarsh
Labels
documentation Improvements or additions to documentation formatter Related to the formatter
Milestone
Formatter: Beta

Comments

@MichaReiser
Copy link
Member

Document

  • how to migrate a project from black to ruff or use ruff's formatter in a new project.
  • the configuration options
  • Suppression comments
@MichaReiser MichaReiser added documentation Improvements or additions to documentation formatter Related to the formatter labels Sep 8, 2023
@charliermarsh
Copy link
Member

I'd be interested in owning the documentation.

@MichaReiser
Copy link
Member Author

I'd be interested in owning the documentation.

Sounds good. The timeline for this is probably a month or so from now.

@charliermarsh charliermarsh mentioned this issue Oct 1, 2023
Merged
charliermarsh added a commit that referenced this issue Oct 20, 2023
@charliermarsh
Rework the documentation to incorporate the Ruff formatter (#7732)
f6d6200 
## Summary

This PR updates our documentation for the upcoming formatter release.

Broadly, the documentation is now structured as follows:

- Overview
- Tutorial
- Installing Ruff
- The Ruff Linter
    - Overview
    - `ruff check`
    - Rule selection
    - Error suppression
    - Exit codes
- The Ruff Formatter
    - Overview
    - `ruff format`
    - Philosophy
    - Configuration
    - Format suppression
    - Exit codes
    - Black compatibility
        - Known deviations
- Configuring Ruff
    - pyproject.toml
    - File discovery
    - Configuration discovery
    - CLI
    - Shell autocompletion
- Preview
- Rules
- Settings
- Integrations
    - `pre-commit`
    - VS Code
    - LSP
    - PyCharm
    - GitHub Actions
- FAQ
- Contributing

The major changes include:

- Removing the "Usage" section from the docs, and instead folding that
information into "Integrations" and the new Linter and Formatter
sections.
- Breaking up "Configuration" into "Configuring Ruff" (for generic
configuration), and new Linter- and Formatter-specific sections.
- Updating all example configurations to use `[tool.ruff.lint]` and
`[tool.ruff.format]`.

My suggestion is to pull and build the docs locally, and review by
reading them in the browser rather than trying to parse all the code
changes.

Closes #7235.

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

@charliermarsh charliermarsh

Labels
documentation Improvements or additions to documentation formatter Related to the formatter
Projects
None yet
Milestone
Formatter: Beta
Development

Successfully merging a pull request may close this issue.

Rework the documentation to incorporate the Ruff formatter astral-sh/ruff
2 participants
@MichaReiser @charliermarsh