summaryrefslogtreecommitdiff
path: root/docs/ref/django-admin.txt
diff options
context:
space:
mode:
authorCarlton Gibson <carlton.gibson@noumenal.es>2022-02-08 12:38:43 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-02-11 12:23:26 +0100
commitd113b5a837f726d1c638d76c4e88445e6cd59fd5 (patch)
tree37191ed160b698bfbf81559b56735d3e83fd7f92 /docs/ref/django-admin.txt
parentf9ec777a826816e20e68021c0e73b5a76be650af (diff)
Refs #33476 -- Made management commands use black.
Run black on generated files, if it is available on PATH.
Diffstat (limited to 'docs/ref/django-admin.txt')
-rw-r--r--docs/ref/django-admin.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt
index a60c538331..793461c265 100644
--- a/docs/ref/django-admin.txt
+++ b/docs/ref/django-admin.txt
@@ -2050,6 +2050,24 @@ distribution. It enables tab-completion of ``django-admin`` and
See :doc:`/howto/custom-management-commands` for how to add customized actions.
+Black formatting
+----------------
+
+.. versionadded:: 4.1
+
+The Python files created by :djadmin:`startproject`, :djadmin:`startapp`,
+:djadmin:`makemigrations`, and :djadmin:`squashmigrations` are formatted using
+the ``black`` command if it is present on your ``PATH``.
+
+If you have ``black`` globally installed, but do not wish it used for the
+current project, you can set the ``PATH`` explicitly::
+
+ PATH=path/to/venv/bin django-admin makemigrations
+
+For commands using ``stdout`` you can pipe the output to ``black`` if needed::
+
+ django-admin inspectdb | black -
+
==========================================
Running management commands from your code
==========================================