1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00

[5.0.x] Refs #34380 -- Improved docs for forms.URLField.assume_scheme.

Backport of 0203771b62 from main
This commit is contained in:
Adam Johnson 2023-11-24 23:00:17 +00:00 committed by Mariusz Felisiak
parent 4d33816ca6
commit 4c74dff759
2 changed files with 10 additions and 6 deletions

View File

@ -1140,12 +1140,16 @@ For each field, we describe the default widget used if you don't specify
* Error message keys: ``required``, ``invalid``
Has the optional arguments ``max_length``, ``min_length``, ``empty_value``
which work just as they do for :class:`CharField`, and ``assume_scheme``
that defaults to ``"http"``.
which work just as they do for :class:`CharField`, and one more argument:
.. versionchanged:: 5.0
.. attribute:: assume_scheme
The ``assume_scheme`` argument was added.
.. versionadded:: 5.0
The scheme assumed for URLs provided without one. Defaults to
``"http"``. For example, if ``assume_scheme`` is ``"https"`` and the
provided value is ``"example.com"``, the normalized value will be
``"https://example.com"``.
.. deprecated:: 5.0

View File

@ -338,8 +338,8 @@ File Storage
Forms
~~~~~
* The new ``assume_scheme`` argument for :class:`~django.forms.URLField` allows
specifying a default URL scheme.
* The new :attr:`~django.forms.URLField.assume_scheme` argument for
:class:`~django.forms.URLField` allows specifying a default URL scheme.
* In order to improve accessibility, the following changes are made: