From 8edccfeca7ee5f495a45089cc8edb4838ee2c637 Mon Sep 17 00:00:00 2001 From: Rolv Apneseth Date: Sun, 30 Oct 2022 22:35:40 +0000 Subject: [PATCH] black: adjust example descriptions for `--diff` and `--check` examples (#9211) * black: modify order and wording on --diff and --check examples * black: changed the learn more link to point to the project's documentation * Update pages/common/black.md Co-authored-by: Axel Navarro Co-authored-by: Axel Navarro --- pages/common/black.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pages/common/black.md b/pages/common/black.md index 07c503b277..e9608b65e8 100644 --- a/pages/common/black.md +++ b/pages/common/black.md @@ -1,7 +1,7 @@ # black > A Python auto code formatter. -> More information: . +> More information: . - Auto-format a file or entire directory: @@ -11,15 +11,15 @@ `black -c "{{code}}"` -- Output the changes that would be applied for each file: - -`black --diff {{path/to/file_or_directory}}` - -- Perform a dry run (print what would be done without actually doing it): +- Output whether a file or a directory would have changes made to them if they were to be formatted: `black --check {{path/to/file_or_directory}}` -- Auto-format a file or directory emitting exclusively error messages to stderr: +- Output changes that would be made to a file or a directory without performing them (dry-run): + +`black --diff {{path/to/file_or_directory}}` + +- Auto-format a file or directory, emitting exclusively error messages to stderr: `black --quiet {{path/to/file_or_directory}}`