mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-06-16 17:09:12 +00:00
Code Issues 32 Releases Wiki Activity

Restructured ref/forms/models to contain both Meta

Browse Source 
options and Factory functions. Reworked text based
on PR feedback.
This commit is contained in:
jernwerber 2024-10-23 12:02:12 -07:00
parent e2da67476f
commit 1306481dda
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/ref/forms/models.txt
View File

@ -78,7 +78,12 @@ Required ``Meta`` Options
.. attribute:: ModelFormOptions.fields .. attribute:: ModelFormOptions.fields
*One of* :attr:`~ModelFormOptions.fields` *and* :attr:`~ModelFormOptions.exclude` *must be set.* Expects a tuple of string or list of strings where each string is the name of a field from the model set in :attr:`~ModelFormOptions.model` or, instead, the single, special string ``'__all__'``. Every field named in :attr:`~ModelFormOptions.fields` will be included in the output form. Non-editable fields cannot be included. *One of* :attr:`~ModelFormOptions.fields` *and*
:attr:`~ModelFormOptions.exclude` *must be set.* Expects a tuple of string
or list of strings where each string is the name of a field from the model
set in :attr:`~ModelFormOptions.model` or, instead, the single, special
string ``'__all__'``. Every field named in :attr:`~ModelFormOptions.fields`
will be included in the output form. Non-editable fields cannot be included.
* If set to the special string ``'__all__'``, all non-editable model fields * If set to the special string ``'__all__'``, all non-editable model fields
will be inlcuded. will be inlcuded.
@ -104,7 +109,13 @@ Required ``Meta`` Options
.. attribute:: ModelFormOptions.exclude .. attribute:: ModelFormOptions.exclude
*One of* :attr:`~ModelFormOptions.fields` *and* :attr:`~ModelFormOptions.exclude` *must be set.* Expects a tuple of strings or list of strings where each string is the name of a field from the model set in :attr:`~ModelFormOptions.model`. Every field named in :attr:`~ModelFormOptions.exclude` will be excluded from the output form, **including fields that are also listed in** :attr:`~ModelFormOptions.fields`. *One of* :attr:`~ModelFormOptions.fields` *and*
:attr:`~ModelFormOptions.exclude` *must be set.* Expects a tuple of strings
or list of strings where each string is the name of a field from the model
set in :attr:`~ModelFormOptions.model`. Every field named in
:attr:`~ModelFormOptions.exclude` will be excluded from the output form,
**including fields that are also listed in**
:attr:`~ModelFormOptions.fields`.
* When using :attr:`~ModelFormOptions.exclude`, leaving * When using :attr:`~ModelFormOptions.exclude`, leaving
:attr:`~ModelFormOptions.fields` unset or setting it to ``None`` has the :attr:`~ModelFormOptions.fields` unset or setting it to ``None`` has the