Skip to content

Move CLI docs to top-level section #27017

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

Open
Joosboy wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Move CLI docs to top-level section #27017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa5e4c6
docs: Move CLI docs to top-level command-line interface section
Joosboy Jul 20, 2026
54f1e89
Docs: Include in CLI docs to resolve #13444
Joosboy Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion crates/ruff_dev/src/generate_cli_help.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ const CHECK_HELP_END_PRAGMA: &str = "<!-- End auto-generated check help. -->";
const FORMAT_HELP_BEGIN_PRAGMA: &str = "<!-- Begin auto-generated format help. -->\n";
const FORMAT_HELP_END_PRAGMA: &str = "<!-- End auto-generated format help. -->";

const ANALYZE_HELP_BEGIN_PRAGMA: &str = "<!-- Begin auto-generated analyze help. -->\n";
const ANALYZE_HELP_END_PRAGMA: &str = "<!-- End auto-generated analyze help. -->";

#[derive(clap::Args)]
pub(crate) struct Args {
#[arg(long, default_value_t, value_enum)]
Expand Down Expand Up @@ -63,15 +66,19 @@ pub(super) fn main(args: &Args) -> Result<()> {
// Generate `ruff help format`.
let format_help = trim_lines(&subcommand_help_text("format")?);

// Generate `ruff help analyze`.
let analyze_help = trim_lines(&subcommand_help_text("analyze")?);

if args.mode.is_dry_run() {
print!("{command_help}");
print!("{check_help}");
print!("{format_help}");
print!("{analyze_help}");
return Ok(());
}

// Read the existing file.
let filename = "docs/configuration.md";
let filename = "docs/cli.md";
let file = PathBuf::from(ROOT_DIR).join(filename);
let existing = fs::read_to_string(&file)?;

Expand All @@ -93,6 +100,12 @@ pub(super) fn main(args: &Args) -> Result<()> {
FORMAT_HELP_BEGIN_PRAGMA,
FORMAT_HELP_END_PRAGMA,
)?;
let new = replace_docs_section(
&new,
&format!("```text\n{analyze_help}\n```\n\n"),
ANALYZE_HELP_BEGIN_PRAGMA,
ANALYZE_HELP_END_PRAGMA,
)?;

match args.mode {
Mode::Check => {
Expand Down
Loading