summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/fields.txt17
-rw-r--r--docs/ref/models/meta.txt5
2 files changed, 6 insertions, 16 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 2d13e96459..2607973d79 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -2500,18 +2500,11 @@ Attributes for fields
.. attribute:: Field.hidden
- Boolean flag that indicates if a field is used to back another non-hidden
- field's functionality (e.g. the ``content_type`` and ``object_id`` fields
- that make up a ``GenericForeignKey``). The ``hidden`` flag is used to
- distinguish what constitutes the public subset of fields on the model from
- all the fields on the model.
-
- .. note::
-
- :meth:`Options.get_fields()
- <django.db.models.options.Options.get_fields()>`
- excludes hidden fields by default. Pass in ``include_hidden=True`` to
- return hidden fields in the results.
+ Boolean flag that indicates if a field is hidden and should not be returned
+ by :meth:`Options.get_fields()
+ <django.db.models.options.Options.get_fields>` by default. An example is
+ the reverse field for a :class:`~django.db.models.ForeignKey` with a
+ ``related_name`` that starts with ``'+'``.
.. attribute:: Field.is_relation
diff --git a/docs/ref/models/meta.txt b/docs/ref/models/meta.txt
index a96c563d49..b3ec23f218 100644
--- a/docs/ref/models/meta.txt
+++ b/docs/ref/models/meta.txt
@@ -79,10 +79,7 @@ Retrieving all field instances of a model
``include_hidden``
``False`` by default. If set to ``True``, ``get_fields()`` will include
- fields that are used to back other field's functionality. This will
- also include any fields that have a ``related_name`` (such
- as :class:`~django.db.models.ManyToManyField`, or
- :class:`~django.db.models.ForeignKey`) that start with a "+".
+ :attr:`hidden fields <django.db.models.Field.hidden>`.
.. code-block:: pycon