diff --git a/pages/common/black.md b/pages/common/black.md new file mode 100644 index 000000000..17469017e --- /dev/null +++ b/pages/common/black.md @@ -0,0 +1,24 @@ +# black + +> A Python auto code formatter. +> More information: . + +- Auto-format a file or entire directory: + +`black {{path/to/file_or_directory}}` + +- Format the code passed in as a string: + +`black -c {{path/to/file_or_directory}}` + +- Output a diff for each file on stdout: + +`black --diff {{path/to/file_or_directory}}` + +- Return the status without writing the files back: + +`black --check {{path/to/file_or_directory}}` + +- Auto-format a file or directory emitting exclusively error messages to stderr: + +`black --quiet {{path/to/file_or_directory}}`