Added tabs for configuration files in the documentation

.pre-commit-config.yaml

@@ -26,13 +26,19 @@ repos:
           - mdformat-admon
         exclude: |
           (?x)^(
-            docs/formatter/black.md
+            docs/formatter/black\.md
+            | docs/\w+\.md
           )$
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.33.0
     hooks:
       - id: markdownlint-fix
+        exclude: |
+          (?x)^(
+            docs/formatter/black\.md
+            | docs/\w+\.md
+          )$
 
   - repo: https://github.com/crate-ci/typos
     rev: v1.14.12

crates/ruff_dev/src/generate_options.rs

@@ -3,6 +3,7 @@
 //! Used for <https://docs.astral.sh/ruff/settings/>.
 use std::fmt::Write;
 
+use ruff_python_trivia::textwrap;
 use ruff_workspace::options::Options;
 use ruff_workspace::options_base::{OptionField, OptionSet, OptionsMetadata, Visit};
 
@@ -125,22 +126,57 @@ fn emit_field(output: &mut String, name: &str, field: &OptionField, parent_set:
     output.push('\n');
     output.push_str(&format!("**Type**: `{}`\n", field.value_type));
     output.push('\n');
-    output.push_str(&format!(
-        "**Example usage**:\n\n```toml\n[tool.ruff{}]\n{}\n```\n",
-        if let Some(set_name) = parent_set.name() {
-            if set_name == "format" {
-                String::from(".format")
-            } else {
-                format!(".lint.{set_name}")
-            }
-        } else {
-            String::new()
-        },
-        field.example
+    output.push_str("**Example usage**:\n\n");
+    output.push_str(&format_tab(
+        "pyproject.toml",
+        &format_header(parent_set, ConfigurationFile::PyprojectToml),
+        field.example,
+    ));
+    output.push_str(&format_tab(
+        "ruff.toml",
+        &format_header(parent_set, ConfigurationFile::RuffToml),
+        field.example,
     ));
     output.push('\n');
 }
 
+fn format_tab(tab_name: &str, header: &str, content: &str) -> String {
+    format!(
+        "=== \"{}\"\n\n    ```toml\n    {}\n{}\n    ```\n",
+        tab_name,
+        header,
+        textwrap::indent(content, "    ")
+    )
+}
+
+fn format_header(parent_set: &Set, configuration: ConfigurationFile) -> String {
+    let fmt = if let Some(set_name) = parent_set.name() {
+        if set_name == "format" {
+            String::from(".format")
+        } else {
+            format!(".lint.{set_name}")
+        }
+    } else {
+        String::new()
+    };
+    match configuration {
+        ConfigurationFile::PyprojectToml => format!("[tool.ruff{fmt}]", fmt = fmt),
+        ConfigurationFile::RuffToml => {
+            if !fmt.is_empty() {
+                format!("[{}]", fmt.strip_prefix('.').unwrap())
+            } else {
+                String::new()
+            }
+        }
+    }
+}
+
+#[derive(Debug)]
+enum ConfigurationFile {
+    PyprojectToml,
+    RuffToml,
+}
+
 #[derive(Default)]
 struct CollectOptionsVisitor {
     groups: Vec<(String, OptionSet)>,