mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-01-03 06:55:47 +00:00
Code Issues 30 Releases Wiki Activity

Added meaningful titles to ..admonition:: directives.

Browse Source
This commit is contained in:
Mariusz Felisiak 2023-04-21 12:03:59 +02:00 committed by GitHub
parent 8ed25d65ea
commit c487634c10
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/ref/contrib/admin/index.txt
View File

@ -327,7 +327,7 @@ subclass::
class FlatPageAdmin(admin.ModelAdmin): class FlatPageAdmin(admin.ModelAdmin):
fields = [("url", "title"), "content"] fields = [("url", "title"), "content"]
.. admonition:: Note .. admonition:: Possible confusion with the ``ModelAdmin.fieldsets`` option
This ``fields`` option should not be confused with the ``fields`` This ``fields`` option should not be confused with the ``fields``
dictionary key that is within the :attr:`~ModelAdmin.fieldsets` option, dictionary key that is within the :attr:`~ModelAdmin.fieldsets` option,
@ -466,7 +466,7 @@ subclass::
For an example see the section :ref:`admin-custom-validation`. For an example see the section :ref:`admin-custom-validation`.
.. admonition:: Note .. admonition:: Omit the ``Meta.model`` attribute
If you define the ``Meta.model`` attribute on a If you define the ``Meta.model`` attribute on a
:class:`~django.forms.ModelForm`, you must also define the :class:`~django.forms.ModelForm`, you must also define the
@ -480,7 +480,7 @@ subclass::
``fields = []`` in the ``Meta`` class to satisfy the validation on the ``fields = []`` in the ``Meta`` class to satisfy the validation on the
``ModelForm``. ``ModelForm``.
.. admonition:: Note .. admonition:: ``ModelAdmin.exclude`` takes precedence
If your ``ModelForm`` and ``ModelAdmin`` both define an ``exclude`` If your ``ModelForm`` and ``ModelAdmin`` both define an ``exclude``
option then ``ModelAdmin`` takes precedence:: option then ``ModelAdmin`` takes precedence::
@ -1786,7 +1786,7 @@ templates used by the :class:`ModelAdmin` views:
kwargs["choices"].append(("ready", "Ready for deployment")) kwargs["choices"].append(("ready", "Ready for deployment"))
return super().formfield_for_choice_field(db_field, request, **kwargs) return super().formfield_for_choice_field(db_field, request, **kwargs)
.. admonition:: Note .. admonition:: ``choices`` limitations
Any ``choices`` attribute set on the formfield will be limited to the Any ``choices`` attribute set on the formfield will be limited to the
form field only. If the corresponding field on the model has choices form field only. If the corresponding field on the model has choices
@ -1817,7 +1817,7 @@ templates used by the :class:`ModelAdmin` views:
def get_changelist_form(self, request, **kwargs): def get_changelist_form(self, request, **kwargs):
return MyForm return MyForm
.. admonition:: Note .. admonition:: Omit the ``Meta.model`` attribute
If you define the ``Meta.model`` attribute on a If you define the ``Meta.model`` attribute on a
:class:`~django.forms.ModelForm`, you must also define the :class:`~django.forms.ModelForm`, you must also define the

2
docs/ref/contrib/index.txt
View File

@ -10,7 +10,7 @@ This code lives in :source:`django/contrib` in the Django distribution. This doc
gives a rundown of the packages in ``contrib``, along with any dependencies gives a rundown of the packages in ``contrib``, along with any dependencies
those packages have. those packages have.
.. admonition:: Note .. admonition:: Including ``contrib`` packages in ``INSTALLED_APPS``
For most of these add-ons -- specifically, the add-ons that include either For most of these add-ons -- specifically, the add-ons that include either
models or template tags -- you'll need to add the package name (e.g., models or template tags -- you'll need to add the package name (e.g.,

2
docs/ref/models/querysets.txt
View File

@ -3820,7 +3820,7 @@ documentation to learn how to create your aggregates.
currently emulates these features using a text field. Attempts to use currently emulates these features using a text field. Attempts to use
aggregation on date/time fields in SQLite will raise ``NotSupportedError``. aggregation on date/time fields in SQLite will raise ``NotSupportedError``.
.. admonition:: Note .. admonition:: Empty queryset
Aggregation functions return ``None`` when used with an empty Aggregation functions return ``None`` when used with an empty
``QuerySet``. For example, the ``Sum`` aggregation function returns ``None`` ``QuerySet``. For example, the ``Sum`` aggregation function returns ``None``

4
docs/ref/settings.txt
View File

@ -3128,7 +3128,7 @@ Default: ``messages.INFO``
Sets the minimum message level that will be recorded by the messages Sets the minimum message level that will be recorded by the messages
framework. See :ref:`message levels <message-level>` for more details. framework. See :ref:`message levels <message-level>` for more details.
.. admonition:: Important .. admonition:: Avoiding circular imports
If you override ``MESSAGE_LEVEL`` in your settings file and rely on any of If you override ``MESSAGE_LEVEL`` in your settings file and rely on any of
the built-in constants, you must import the constants module directly to the built-in constants, you must import the constants module directly to
@ -3183,7 +3183,7 @@ rendered as a CSS class in HTML. If you specify a value, it will extend
the default. This means you only have to specify those values which you need the default. This means you only have to specify those values which you need
to override. See :ref:`message-displaying` above for more details. to override. See :ref:`message-displaying` above for more details.
.. admonition:: Important .. admonition:: Avoiding circular imports
If you override ``MESSAGE_TAGS`` in your settings file and rely on any of If you override ``MESSAGE_TAGS`` in your settings file and rely on any of
the built-in constants, you must import the ``constants`` module directly to the built-in constants, you must import the ``constants`` module directly to

2
docs/topics/templates.txt
View File

@ -396,7 +396,7 @@ here's what Django will look for:
When Django finds a template that exists, it stops looking. When Django finds a template that exists, it stops looking.
.. admonition:: Tip .. admonition:: Use ``django.template.loader.select_template()`` for more flexibility
You can use :func:`~django.template.loader.select_template()` for flexible You can use :func:`~django.template.loader.select_template()` for flexible
template loading. For example, if you've written a news story and want template loading. For example, if you've written a news story and want