mirror of
https://github.com/django/django.git
synced 2025-10-24 22:26:08 +00:00
Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question. Rather, I went through all of the occurrences of the words listed below, and judged if they a) suggested the reader had some kind of knowledge/experience, and b) if they added anything of value (including tone of voice, etc). I left most of the words alone. I looked at the following words: - simply/simple - easy/easier/easiest - obvious - just - merely - straightforward - ridiculous Thanks to Carlton Gibson for guidance on how to approach this issue, and to Tim Bell for providing the idea. But the enormous lion's share of thanks go to Adam Johnson for his patient and helpful review.
This commit is contained in:
committed by
Mariusz Felisiak
parent
addabc492b
commit
4a954cfd11
@@ -332,5 +332,5 @@ Date-based mixins
|
||||
return the list of years for which ``qs`` has entries. If
|
||||
``date_type`` isn't provided, the result of
|
||||
:meth:`~BaseDateListView.get_date_list_period` is used. ``date_type``
|
||||
and ``ordering`` are simply passed to
|
||||
and ``ordering`` are passed to
|
||||
:meth:`QuerySet.dates()<django.db.models.query.QuerySet.dates>`.
|
||||
|
||||
@@ -209,8 +209,8 @@ The following mixins are used to construct Django's editing views:
|
||||
|
||||
.. method:: put(*args, **kwargs)
|
||||
|
||||
The ``PUT`` action is also handled and just passes all parameters
|
||||
through to :meth:`post`.
|
||||
The ``PUT`` action is also handled and passes all parameters through to
|
||||
:meth:`post`.
|
||||
|
||||
|
||||
``DeletionMixin``
|
||||
|
||||
@@ -136,8 +136,7 @@ Multiple object mixins
|
||||
.. method:: get_paginate_by(queryset)
|
||||
|
||||
Returns the number of items to paginate by, or ``None`` for no
|
||||
pagination. By default this simply returns the value of
|
||||
:attr:`paginate_by`.
|
||||
pagination. By default this returns the value of :attr:`paginate_by`.
|
||||
|
||||
.. method:: get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True)
|
||||
|
||||
@@ -147,7 +146,7 @@ Multiple object mixins
|
||||
.. method:: get_paginate_orphans()
|
||||
|
||||
An integer specifying the number of "overflow" objects the last page
|
||||
can contain. By default this simply returns the value of
|
||||
can contain. By default this returns the value of
|
||||
:attr:`paginate_orphans`.
|
||||
|
||||
.. method:: get_allow_empty()
|
||||
|
||||
@@ -12,7 +12,7 @@ Simple mixins
|
||||
.. attribute:: extra_context
|
||||
|
||||
A dictionary to include in the context. This is a convenient way of
|
||||
specifying some simple context in
|
||||
specifying some context in
|
||||
:meth:`~django.views.generic.base.View.as_view`. Example usage::
|
||||
|
||||
from django.views.generic import TemplateView
|
||||
|
||||
@@ -63,7 +63,7 @@ Single object mixins
|
||||
with access to individual objects should be prevented from obtaining
|
||||
this list, setting ``query_pk_and_slug`` to ``True`` will help prevent
|
||||
the guessing of URLs as each URL will require two correct,
|
||||
non-sequential arguments. Simply using a unique slug may serve the same
|
||||
non-sequential arguments. Using a unique slug may serve the same
|
||||
purpose, but this scheme allows you to have non-unique slugs.
|
||||
|
||||
.. _insecure direct object reference: https://www.owasp.org/index.php/Top_10_2013-A4-Insecure_Direct_Object_References
|
||||
@@ -128,7 +128,7 @@ Single object mixins
|
||||
.. method:: get_slug_field()
|
||||
|
||||
Returns the name of a slug field to be used to look up by slug. By
|
||||
default this simply returns the value of :attr:`slug_field`.
|
||||
default this returns the value of :attr:`slug_field`.
|
||||
|
||||
|
||||
``SingleObjectTemplateResponseMixin``
|
||||
|
||||
Reference in New Issue
Block a user