Avoided counting attributes and methods in docs.

This commit is contained in:
Mariusz Felisiak 2021-12-28 12:36:57 +01:00 committed by GitHub
parent b13d920b7b
commit ad6bb20557
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 37 additions and 49 deletions

View File

@ -240,13 +240,11 @@ field or an expression returning a numeric data. Both are required.
Returns the population covariance as a ``float``, or ``default`` if there Returns the population covariance as a ``float``, or ``default`` if there
aren't any matching rows. aren't any matching rows.
Has one optional argument:
.. attribute:: sample .. attribute:: sample
By default ``CovarPop`` returns the general population covariance. Optional. By default ``CovarPop`` returns the general population
However, if ``sample=True``, the return value will be the sample covariance. However, if ``sample=True``, the return value will be the
population covariance. sample population covariance.
``RegrAvgX`` ``RegrAvgX``
------------ ------------

View File

@ -374,7 +374,7 @@ For each field, we describe the default widget used if you don't specify
``min_length`` are provided. Otherwise, all inputs are valid. ``min_length`` are provided. Otherwise, all inputs are valid.
* Error message keys: ``required``, ``max_length``, ``min_length`` * Error message keys: ``required``, ``max_length``, ``min_length``
Has four optional arguments for validation: Has the following optional arguments for validation:
.. attribute:: max_length .. attribute:: max_length
.. attribute:: min_length .. attribute:: min_length
@ -550,7 +550,7 @@ For each field, we describe the default widget used if you don't specify
regular expression. regular expression.
* Error message keys: ``required``, ``invalid`` * Error message keys: ``required``, ``invalid``
Has three optional arguments ``max_length``, ``min_length``, and Has the optional arguments ``max_length``, ``min_length``, and
``empty_value`` which work just as they do for :class:`CharField`. ``empty_value`` which work just as they do for :class:`CharField`.
``FileField`` ``FileField``
@ -566,7 +566,7 @@ For each field, we describe the default widget used if you don't specify
* Error message keys: ``required``, ``invalid``, ``missing``, ``empty``, * Error message keys: ``required``, ``invalid``, ``missing``, ``empty``,
``max_length`` ``max_length``
Has two optional arguments for validation, ``max_length`` and Has the optional arguments for validation: ``max_length`` and
``allow_empty_file``. If provided, these ensure that the file name is at ``allow_empty_file``. If provided, these ensure that the file name is at
most the given length, and that validation will succeed even if the file most the given length, and that validation will succeed even if the file
content is empty. content is empty.
@ -1009,7 +1009,7 @@ For each field, we describe the default widget used if you don't specify
given value is a valid URL. given value is a valid URL.
* Error message keys: ``required``, ``invalid`` * Error message keys: ``required``, ``invalid``
Has three optional arguments ``max_length``, ``min_length``, and Has the optional arguments ``max_length``, ``min_length``, and
``empty_value`` which work just as they do for :class:`CharField`. ``empty_value`` which work just as they do for :class:`CharField`.
``UUIDField`` ``UUIDField``

View File

@ -569,12 +569,10 @@ A field to store raw binary data. It can be assigned :class:`bytes`,
By default, ``BinaryField`` sets :attr:`~Field.editable` to ``False``, in which By default, ``BinaryField`` sets :attr:`~Field.editable` to ``False``, in which
case it can't be included in a :class:`~django.forms.ModelForm`. case it can't be included in a :class:`~django.forms.ModelForm`.
``BinaryField`` has one extra optional argument:
.. attribute:: BinaryField.max_length .. attribute:: BinaryField.max_length
The maximum length (in bytes) of the field. The maximum length is enforced Optional. The maximum length (in bytes) of the field. The maximum length is
in Django's validation using enforced in Django's validation using
:class:`~django.core.validators.MaxLengthValidator`. :class:`~django.core.validators.MaxLengthValidator`.
.. admonition:: Abusing ``BinaryField`` .. admonition:: Abusing ``BinaryField``
@ -607,7 +605,7 @@ For large amounts of text, use :class:`~django.db.models.TextField`.
The default form widget for this field is a :class:`~django.forms.TextInput`. The default form widget for this field is a :class:`~django.forms.TextInput`.
:class:`CharField` has two extra arguments: :class:`CharField` has the following extra arguments:
.. attribute:: CharField.max_length .. attribute:: CharField.max_length
@ -713,7 +711,7 @@ A fixed-precision decimal number, represented in Python by a
:class:`~decimal.Decimal` instance. It validates the input using :class:`~decimal.Decimal` instance. It validates the input using
:class:`~django.core.validators.DecimalValidator`. :class:`~django.core.validators.DecimalValidator`.
Has two **required** arguments: Has the following **required** arguments:
.. attribute:: DecimalField.max_digits .. attribute:: DecimalField.max_digits
@ -781,7 +779,7 @@ A file-upload field.
The ``primary_key`` argument isn't supported and will raise an error if The ``primary_key`` argument isn't supported and will raise an error if
used. used.
Has two optional arguments: Has the following optional arguments:
.. attribute:: FileField.upload_to .. attribute:: FileField.upload_to
@ -1153,8 +1151,8 @@ validates that the uploaded object is a valid image.
In addition to the special attributes that are available for :class:`FileField`, In addition to the special attributes that are available for :class:`FileField`,
an :class:`ImageField` also has ``height`` and ``width`` attributes. an :class:`ImageField` also has ``height`` and ``width`` attributes.
To facilitate querying on those attributes, :class:`ImageField` has two extra To facilitate querying on those attributes, :class:`ImageField` has the
optional arguments: following optional arguments:
.. attribute:: ImageField.height_field .. attribute:: ImageField.height_field

View File

@ -147,7 +147,7 @@ Here's the formal declaration of a ``QuerySet``:
``QuerySet`` methods return new querysets. These methods are covered in ``QuerySet`` methods return new querysets. These methods are covered in
detail later in this section. detail later in this section.
The ``QuerySet`` class has two public attributes you can use for The ``QuerySet`` class has the following public attributes you can use for
introspection: introspection:
.. attribute:: ordered .. attribute:: ordered
@ -3599,13 +3599,11 @@ by the aggregate.
* Return type: ``float`` if input is ``int``, otherwise same as input * Return type: ``float`` if input is ``int``, otherwise same as input
field, or ``output_field`` if supplied field, or ``output_field`` if supplied
Has one optional argument:
.. attribute:: distinct .. attribute:: distinct
If ``distinct=True``, ``Avg`` returns the mean value of unique values. Optional. If ``distinct=True``, ``Avg`` returns the mean value of
This is the SQL equivalent of ``AVG(DISTINCT <field>)``. The default unique values. This is the SQL equivalent of ``AVG(DISTINCT <field>)``.
value is ``False``. The default value is ``False``.
``Count`` ``Count``
~~~~~~~~~ ~~~~~~~~~
@ -3618,13 +3616,11 @@ by the aggregate.
* Default alias: ``<field>__count`` * Default alias: ``<field>__count``
* Return type: ``int`` * Return type: ``int``
Has one optional argument:
.. attribute:: distinct .. attribute:: distinct
If ``distinct=True``, the count will only include unique instances. Optional. If ``distinct=True``, the count will only include unique
This is the SQL equivalent of ``COUNT(DISTINCT <field>)``. The default instances. This is the SQL equivalent of ``COUNT(DISTINCT <field>)``.
value is ``False``. The default value is ``False``.
.. note:: .. note::
@ -3661,12 +3657,11 @@ by the aggregate.
* Return type: ``float`` if input is ``int``, otherwise same as input * Return type: ``float`` if input is ``int``, otherwise same as input
field, or ``output_field`` if supplied field, or ``output_field`` if supplied
Has one optional argument:
.. attribute:: sample .. attribute:: sample
By default, ``StdDev`` returns the population standard deviation. However, Optional. By default, ``StdDev`` returns the population standard
if ``sample=True``, the return value will be the sample standard deviation. deviation. However, if ``sample=True``, the return value will be the
sample standard deviation.
``Sum`` ``Sum``
~~~~~~~ ~~~~~~~
@ -3678,13 +3673,11 @@ by the aggregate.
* Default alias: ``<field>__sum`` * Default alias: ``<field>__sum``
* Return type: same as input field, or ``output_field`` if supplied * Return type: same as input field, or ``output_field`` if supplied
Has one optional argument:
.. attribute:: distinct .. attribute:: distinct
If ``distinct=True``, ``Sum`` returns the sum of unique values. This is Optional. If ``distinct=True``, ``Sum`` returns the sum of unique
the SQL equivalent of ``SUM(DISTINCT <field>)``. The default value is values. This is the SQL equivalent of ``SUM(DISTINCT <field>)``. The
``False``. default value is ``False``.
``Variance`` ``Variance``
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -3697,12 +3690,11 @@ by the aggregate.
* Return type: ``float`` if input is ``int``, otherwise same as input * Return type: ``float`` if input is ``int``, otherwise same as input
field, or ``output_field`` if supplied field, or ``output_field`` if supplied
Has one optional argument:
.. attribute:: sample .. attribute:: sample
By default, ``Variance`` returns the population variance. However, Optional. By default, ``Variance`` returns the population variance.
if ``sample=True``, the return value will be the sample variance. However, if ``sample=True``, the return value will be the sample
variance.
Query-related tools Query-related tools
=================== ===================

View File

@ -247,7 +247,7 @@ stores passwords using PBKDF2.
Argon2 Argon2
~~~~~~ ~~~~~~
Argon2 has three attributes that can be customized: Argon2 has the following attributes that can be customized:
#. ``time_cost`` controls the number of iterations within the hash. #. ``time_cost`` controls the number of iterations within the hash.
#. ``memory_cost`` controls the size of memory that must be used during the #. ``memory_cost`` controls the size of memory that must be used during the
@ -277,7 +277,7 @@ follows:
.. versionadded:: 4.0 .. versionadded:: 4.0
scrypt_ has four attributes that can be customized: scrypt_ has the following attributes that can be customized:
#. ``work_factor`` controls the number of iterations within the hash. #. ``work_factor`` controls the number of iterations within the hash.
#. ``block_size`` #. ``block_size``

View File

@ -594,8 +594,8 @@ database other than that specified by your router chain, you'll
need to write custom :class:`~django.contrib.admin.ModelAdmin` classes need to write custom :class:`~django.contrib.admin.ModelAdmin` classes
that will direct the admin to use a specific database for content. that will direct the admin to use a specific database for content.
``ModelAdmin`` objects have five methods that require customization for ``ModelAdmin`` objects have the following methods that require customization
multiple-database support:: for multiple-database support::
class MultiDBModelAdmin(admin.ModelAdmin): class MultiDBModelAdmin(admin.ModelAdmin):
# A handy constant for the name of the alternate database. # A handy constant for the name of the alternate database.

View File

@ -769,7 +769,7 @@ This is useful if you want to :ref:`use more than one formset in a view
Using a formset in views and templates Using a formset in views and templates
====================================== ======================================
Formsets have five attributes and five methods associated with rendering. Formsets have the following attributes and methods associated with rendering:
.. attribute:: BaseFormSet.renderer .. attribute:: BaseFormSet.renderer

View File

@ -586,8 +586,8 @@ Expiration policies for these cookies are not followed. If you want a cookie
to expire, either delete it manually or create a new ``Client`` instance (which to expire, either delete it manually or create a new ``Client`` instance (which
will effectively delete all cookies). will effectively delete all cookies).
A test client has two attributes that store persistent state information. You A test client has attributes that store persistent state information. You can
can access these properties as part of a test condition. access these properties as part of a test condition.
.. attribute:: Client.cookies .. attribute:: Client.cookies