فهرست منبع

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 <navarroaxel@gmail.com>

Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
Rolv Apneseth 2 سال پیش
والد
کامیت
8edccfeca7
1فایلهای تغییر یافته به همراه6 افزوده شده و 6 حذف شده
  1. 6 6
      pages/common/black.md

+ 6 - 6
pages/common/black.md

@@ -1,7 +1,7 @@
 # black
 
 > A Python auto code formatter.
-> More information: <https://github.com/psf/black>.
+> More information: <https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html>.
 
 - Auto-format a file or entire directory:
 
@@ -11,15 +11,15 @@
 
 `black -c "{{code}}"`
 
-- Output the changes that would be applied for each file:
+- Output whether a file or a directory would have changes made to them if they were to be formatted:
 
-`black --diff {{path/to/file_or_directory}}`
+`black --check {{path/to/file_or_directory}}`
 
-- Perform a dry run (print what would be done without actually doing it):
+- Output changes that would be made to a file or a directory without performing them (dry-run):
 
-`black --check {{path/to/file_or_directory}}`
+`black --diff {{path/to/file_or_directory}}`
 
-- Auto-format a file or directory emitting exclusively error messages to stderr:
+- Auto-format a file or directory, emitting exclusively error messages to stderr:
 
 `black --quiet {{path/to/file_or_directory}}`