docs: regenerate docs

astral-sh · Jan 24, 2024 · 4da48d4 · 4da48d4
1 parent 36d27de
commit 4da48d4
Showing 1 changed file with 40 additions and 80 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -502,62 +502,35 @@ Arguments:
   [FILES]...  List of files or directories to check [default: .]
 
 Options:
-      --fix
-          Apply fixes to resolve lint violations. Use `--no-fix` to disable or `--unsafe-fixes` to include unsafe fixes
-      --unsafe-fixes
-          Include fixes that may not retain the original intent of the code. Use `--no-unsafe-fixes` to disable
-      --show-source
-          Show violations with source code. Use `--no-show-source` to disable
-      --show-fixes
-          Show an enumeration of all fixed lint violations. Use `--no-show-fixes` to disable
-      --diff
-          Avoid writing any fixed files back; instead, output a diff for each changed file to stdout. Implies `--fix-only`
-  -w, --watch
-          Run in watch mode by re-running whenever files change
-      --fix-only
-          Apply fixes to resolve lint violations, but don't report on leftover violations. Implies `--fix`. Use `--no-fix-only` to disable or `--unsafe-fixes` to include unsafe fixes
-      --ignore-noqa
-          Ignore any `# noqa` comments
-      --output-format <OUTPUT_FORMAT>
-          Output serialization format for violations [env: RUFF_OUTPUT_FORMAT=] [possible values: text, json, json-lines, junit, grouped, github, gitlab, pylint, azure, sarif]
-  -o, --output-file <OUTPUT_FILE>
-          Specify file to write the linter output to (default: stdout)
-      --target-version <TARGET_VERSION>
-          The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312]
-      --preview
-          Enable preview mode; checks will include unstable rules and fixes. Use `--no-preview` to disable
-      --config <CONFIG>
-          Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
-      --extension <EXTENSION>
-          List of mappings from file extension to language (one of ["python", "ipynb", "pyi"]). For example, to treat `.ipy` files as IPython notebooks, use `--extension ipy:ipynb`
-      --statistics
-          Show counts for every rule with at least one violation
-      --add-noqa
-          Enable automatic additions of `noqa` directives to failing lines
-      --show-files
-          See the files Ruff will be run against with the current settings
-      --show-settings
-          See the settings Ruff will use to lint a given Python file
-  -h, --help
-          Print help
+      --fix                              Apply fixes to resolve lint violations. Use `--no-fix` to disable or `--unsafe-fixes` to include unsafe fixes
+      --unsafe-fixes                     Include fixes that may not retain the original intent of the code. Use `--no-unsafe-fixes` to disable
+      --show-source                      Show violations with source code. Use `--no-show-source` to disable
+      --show-fixes                       Show an enumeration of all fixed lint violations. Use `--no-show-fixes` to disable
+      --diff                             Avoid writing any fixed files back; instead, output a diff for each changed file to stdout. Implies `--fix-only`
+  -w, --watch                            Run in watch mode by re-running whenever files change
+      --fix-only                         Apply fixes to resolve lint violations, but don't report on leftover violations. Implies `--fix`. Use `--no-fix-only` to disable or `--unsafe-fixes` to include unsafe fixes
+      --ignore-noqa                      Ignore any `# noqa` comments
+      --output-format <OUTPUT_FORMAT>    Output serialization format for violations [env: RUFF_OUTPUT_FORMAT=] [possible values: text, json, json-lines, junit, grouped, github, gitlab, pylint, azure, sarif]
+  -o, --output-file <OUTPUT_FILE>        Specify file to write the linter output to (default: stdout)
+      --target-version <TARGET_VERSION>  The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312]
+      --preview                          Enable preview mode; checks will include unstable rules and fixes. Use `--no-preview` to disable
+      --config <CONFIG>                  Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
+      --extension <EXTENSION>            List of mappings from file extension to language (one of ["python", "ipynb", "pyi"]). For example, to treat `.ipy` files as IPython notebooks, use `--extension ipy:ipynb`
+      --statistics                       Show counts for every rule with at least one violation
+      --add-noqa                         Enable automatic additions of `noqa` directives to failing lines
+      --show-files                       See the files Ruff will be run against with the current settings
+      --show-settings                    See the settings Ruff will use to lint a given Python file
+  -h, --help                             Print help
 
 Rule selection:
-      --select <RULE_CODE>
-          Comma-separated list of rule codes to enable (or ALL, to enable all rules)
-      --ignore <RULE_CODE>
-          Comma-separated list of rule codes to disable
-      --extend-select <RULE_CODE>
-          Like --select, but adds additional rule codes on top of those already specified
-      --per-file-ignores <PER_FILE_IGNORES>
-          List of mappings from file pattern to code to exclude
-      --extend-per-file-ignores <EXTEND_PER_FILE_IGNORES>
-          Like `--per-file-ignores`, but adds additional ignores on top of those already specified
-      --fixable <RULE_CODE>
-          List of rule codes to treat as eligible for fix. Only applicable when fix itself is enabled (e.g., via `--fix`)
-      --unfixable <RULE_CODE>
-          List of rule codes to treat as ineligible for fix. Only applicable when fix itself is enabled (e.g., via `--fix`)
-      --extend-fixable <RULE_CODE>
-          Like --fixable, but adds additional rule codes on top of those already specified
+      --select <RULE_CODE>                                 Comma-separated list of rule codes to enable (or ALL, to enable all rules)
+      --ignore <RULE_CODE>                                 Comma-separated list of rule codes to disable
+      --extend-select <RULE_CODE>                          Like --select, but adds additional rule codes on top of those already specified
+      --per-file-ignores <PER_FILE_IGNORES>                List of mappings from file pattern to code to exclude
+      --extend-per-file-ignores <EXTEND_PER_FILE_IGNORES>  Like `--per-file-ignores`, but adds additional ignores on top of those already specified
+      --fixable <RULE_CODE>                                List of rule codes to treat as eligible for fix. Only applicable when fix itself is enabled (e.g., via `--fix`)
+      --unfixable <RULE_CODE>                              List of rule codes to treat as ineligible for fix. Only applicable when fix itself is enabled (e.g., via `--fix`)
+      --extend-fixable <RULE_CODE>                         Like --fixable, but adds additional rule codes on top of those already specified
 
 File selection:
       --exclude <FILE_PATTERN>         List of paths, used to omit files and/or directories from analysis
@@ -566,18 +539,12 @@ File selection:
       --force-exclude                  Enforce exclusions, even for paths passed to Ruff directly on the command-line. Use `--no-force-exclude` to disable
 
 Miscellaneous:
-  -n, --no-cache
-          Disable cache reads [env: RUFF_NO_CACHE=]
-      --isolated
-          Ignore all configuration files
-      --cache-dir <CACHE_DIR>
-          Path to the cache directory [env: RUFF_CACHE_DIR=]
-      --stdin-filename <STDIN_FILENAME>
-          The name of the file when passing it through stdin
-  -e, --exit-zero
-          Exit with status code "0", even upon detecting lint violations
-      --exit-non-zero-on-fix
-          Exit with a non-zero status code if any files were modified via fix, even if no lint violations remain
+  -n, --no-cache                         Disable cache reads [env: RUFF_NO_CACHE=]
+      --isolated                         Ignore all configuration files
+      --cache-dir <CACHE_DIR>            Path to the cache directory [env: RUFF_CACHE_DIR=]
+      --stdin-filename <STDIN_FILENAME>  The name of the file when passing it through stdin
+  -e, --exit-zero                        Exit with status code "0", even upon detecting lint violations
+      --exit-non-zero-on-fix             Exit with a non-zero status code if any files were modified via fix, even if no lint violations remain
 
 Log levels:
   -v, --verbose  Enable verbose logging
@@ -600,20 +567,13 @@ Arguments:
   [FILES]...  List of files or directories to format [default: .]
 
 Options:
-      --check
-          Avoid writing any formatted files back; instead, exit with a non-zero status code if any files would have been modified, and zero otherwise
-      --diff
-          Avoid writing any formatted files back; instead, exit with a non-zero status code and the difference between the current file and how the formatted file would look like
-      --config <CONFIG>
-          Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
-      --extension <EXTENSION>
-          List of mappings from file extension to language (one of ["python", "ipynb", "pyi"]). For example, to treat `.ipy` files as IPython notebooks, use `--extension ipy:ipynb`
-      --target-version <TARGET_VERSION>
-          The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312]
-      --preview
-          Enable preview mode; enables unstable formatting. Use `--no-preview` to disable
-  -h, --help
-          Print help
+      --check                            Avoid writing any formatted files back; instead, exit with a non-zero status code if any files would have been modified, and zero otherwise
+      --diff                             Avoid writing any formatted files back; instead, exit with a non-zero status code and the difference between the current file and how the formatted file would look like
+      --config <CONFIG>                  Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
+      --extension <EXTENSION>            List of mappings from file extension to language (one of ["python", "ipynb", "pyi"]). For example, to treat `.ipy` files as IPython notebooks, use `--extension ipy:ipynb`
+      --target-version <TARGET_VERSION>  The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312]
+      --preview                          Enable preview mode; enables unstable formatting. Use `--no-preview` to disable
+  -h, --help                             Print help
 
 Miscellaneous:
   -n, --no-cache                         Disable cache reads [env: RUFF_NO_CACHE=]