Document ruff_dev and format_dev (#5648)

## Summary

Document all `ruff_dev` subcommands and document the `format_dev` flags
in the formatter readme.

CC @zanieb please flag everything that isn't clear or missing

## Test Plan

n/a
This commit is contained in:
konsti 2023-07-12 16:18:22 +02:00 committed by GitHub
parent 5665968b42
commit f0aa6bd4d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 145 additions and 2 deletions

View file

@ -21,7 +21,7 @@ pub(crate) enum Mode {
/// Don't write to the file, check if the file is up-to-date and error if not.
Check,
/// Write the generated help to stdout (rather than to `docs/configuration.md`).
/// Write the generated help to stdout.
DryRun,
}

View file

@ -1,4 +1,6 @@
//! Generate a Markdown-compatible listing of configuration options.
//! Generate a Markdown-compatible listing of configuration options for `pyproject.toml`.
//!
//! Used for <https://beta.ruff.rs/docs/settings/>.
use itertools::Itertools;
use ruff::settings::options::Options;

View file

@ -1,4 +1,6 @@
//! Generate a Markdown-compatible table of supported lint rules.
//!
//! Used for <https://beta.ruff.rs/docs/rules/>.
use itertools::Itertools;
use strum::IntoEnumIterator;