summaryrefslogtreecommitdiff
path: root/docs/howto
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2024-01-26 12:45:07 +0100
committerGitHub <noreply@github.com>2024-01-26 12:45:07 +0100
commit305757aec19c9d5111e4d76095ae0acd66163e4b (patch)
tree04aa017e66c06b3b19cb466ed4e1d73cd871523d /docs/howto
parent3f6d939c62efd967f548c27a265748cc2cc47ca5 (diff)
Applied Black's 2024 stable style.
https://github.com/psf/black/releases/tag/24.1.0
Diffstat (limited to 'docs/howto')
-rw-r--r--docs/howto/csrf.txt3
-rw-r--r--docs/howto/custom-file-storage.txt3
-rw-r--r--docs/howto/custom-lookups.txt3
-rw-r--r--docs/howto/custom-management-commands.txt3
-rw-r--r--docs/howto/custom-model-fields.txt12
-rw-r--r--docs/howto/custom-template-tags.txt9
-rw-r--r--docs/howto/error-reporting.txt9
7 files changed, 14 insertions, 28 deletions
diff --git a/docs/howto/csrf.txt b/docs/howto/csrf.txt
index 07f2e20a1c..d40f4b4cb4 100644
--- a/docs/howto/csrf.txt
+++ b/docs/howto/csrf.txt
@@ -208,8 +208,7 @@ will require a CSRF token to be inserted you should use the
@cache_page(60 * 15)
@csrf_protect
- def my_view(request):
- ...
+ def my_view(request): ...
If you are using class-based views, you can refer to :ref:`Decorating
class-based views<decorating-class-based-views>`.
diff --git a/docs/howto/custom-file-storage.txt b/docs/howto/custom-file-storage.txt
index b7bd22d9c1..3cc96cce84 100644
--- a/docs/howto/custom-file-storage.txt
+++ b/docs/howto/custom-file-storage.txt
@@ -14,8 +14,7 @@ You'll need to follow these steps:
from django.core.files.storage import Storage
- class MyStorage(Storage):
- ...
+ class MyStorage(Storage): ...
#. Django must be able to instantiate your storage system without any arguments.
This means that any settings should be taken from ``django.conf.settings``::
diff --git a/docs/howto/custom-lookups.txt b/docs/howto/custom-lookups.txt
index 61ec9295eb..fc8e928890 100644
--- a/docs/howto/custom-lookups.txt
+++ b/docs/howto/custom-lookups.txt
@@ -53,8 +53,7 @@ Lookup registration can also be done using a decorator pattern::
@Field.register_lookup
- class NotEqualLookup(Lookup):
- ...
+ class NotEqualLookup(Lookup): ...
We can now use ``foo__ne`` for any field ``foo``. You will need to ensure that
this registration happens before you try to create any querysets using it. You
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt
index 8bdfb1e38b..b472f092e9 100644
--- a/docs/howto/custom-management-commands.txt
+++ b/docs/howto/custom-management-commands.txt
@@ -146,8 +146,7 @@ decorator on your :meth:`~BaseCommand.handle` method::
...
@no_translations
- def handle(self, *args, **options):
- ...
+ def handle(self, *args, **options): ...
Since translation deactivation requires access to configured settings, the
decorator can't be used for commands that work without configured settings.
diff --git a/docs/howto/custom-model-fields.txt b/docs/howto/custom-model-fields.txt
index 1e7ac4f0ba..b4a1537896 100644
--- a/docs/howto/custom-model-fields.txt
+++ b/docs/howto/custom-model-fields.txt
@@ -338,24 +338,20 @@ Changing a custom field's base class
You can't change the base class of a custom field because Django won't detect
the change and make a migration for it. For example, if you start with::
- class CustomCharField(models.CharField):
- ...
+ class CustomCharField(models.CharField): ...
and then decide that you want to use ``TextField`` instead, you can't change
the subclass like this::
- class CustomCharField(models.TextField):
- ...
+ class CustomCharField(models.TextField): ...
Instead, you must create a new custom field class and update your models to
reference it::
- class CustomCharField(models.CharField):
- ...
+ class CustomCharField(models.CharField): ...
- class CustomTextField(models.TextField):
- ...
+ class CustomTextField(models.TextField): ...
As discussed in :ref:`removing fields <migrations-removing-model-fields>`, you
must retain the original ``CustomCharField`` class as long as you have
diff --git a/docs/howto/custom-template-tags.txt b/docs/howto/custom-template-tags.txt
index c7909c8a4b..15bef9b5fb 100644
--- a/docs/howto/custom-template-tags.txt
+++ b/docs/howto/custom-template-tags.txt
@@ -561,8 +561,7 @@ template loader, we'd register the tag like this::
# Here, register is a django.template.Library instance, as before
@register.inclusion_tag("results.html")
- def show_results(poll):
- ...
+ def show_results(poll): ...
Alternatively it is possible to register the inclusion tag using a
:class:`django.template.Template` instance::
@@ -917,13 +916,11 @@ The ``tag()`` method takes two arguments:
As with filter registration, it is also possible to use this as a decorator::
@register.tag(name="current_time")
- def do_current_time(parser, token):
- ...
+ def do_current_time(parser, token): ...
@register.tag
- def shout(parser, token):
- ...
+ def shout(parser, token): ...
If you leave off the ``name`` argument, as in the second example above, Django
will use the function's name as the tag name.
diff --git a/docs/howto/error-reporting.txt b/docs/howto/error-reporting.txt
index 84fe3cb768..b36f884096 100644
--- a/docs/howto/error-reporting.txt
+++ b/docs/howto/error-reporting.txt
@@ -177,8 +177,7 @@ filtered out of error reports in a production environment (that is, where
do not provide any argument to the ``sensitive_variables`` decorator::
@sensitive_variables()
- def my_function():
- ...
+ def my_function(): ...
.. admonition:: When using multiple decorators
@@ -191,8 +190,7 @@ filtered out of error reports in a production environment (that is, where
@sensitive_variables("user", "pw", "cc")
@some_decorator
@another_decorator
- def process_info(user):
- ...
+ def process_info(user): ...
.. versionchanged:: 5.0
@@ -229,8 +227,7 @@ filtered out of error reports in a production environment (that is, where
do not provide any argument to the ``sensitive_post_parameters`` decorator::
@sensitive_post_parameters()
- def my_view(request):
- ...
+ def my_view(request): ...
All POST parameters are systematically filtered out of error reports for
certain :mod:`django.contrib.auth.views` views (``login``,