lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-29 23:24:55 +02:00
Code Activity
tldr/pages/common/black.md
Rolv Apneseth 8edccfeca7
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>
2022-10-30 23:35:40 +01:00

919 B
Raw Blame History

black

A Python auto code formatter. More information: https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html.

  • Auto-format a file or entire directory:

black {{path/to/file_or_directory}}

  • Format the code passed in as a string:

black -c "{{code}}"

  • 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}}

  • 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}}

  • Auto-format a file or directory without replacing single quotes with double quotes (adoption helper, avoid using this for new projects):

black --skip-string-normalization {{path/to/file_or_directory}}