From d113b5a837f726d1c638d76c4e88445e6cd59fd5 Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Tue, 8 Feb 2022 12:38:43 +0100 Subject: Refs #33476 -- Made management commands use black. Run black on generated files, if it is available on PATH. --- docs/ref/django-admin.txt | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'docs/ref/django-admin.txt') 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 ========================================== -- cgit v1.3