diff options
| author | Tobias Kunze <r@rixx.de> | 2019-06-17 16:54:55 +0200 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-09-06 13:27:46 +0200 |
| commit | 4a954cfd11a5d034491f87fcbc920eb97a302bb3 (patch) | |
| tree | 1c92caae5d8a9b33c51ddd74b4b2061248f3915f /docs/ref/class-based-views | |
| parent | addabc492bdc0191ac95d59ec34b56b34086ebb9 (diff) | |
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.
Diffstat (limited to 'docs/ref/class-based-views')
5 files changed, 8 insertions, 9 deletions
diff --git a/docs/ref/class-based-views/mixins-date-based.txt b/docs/ref/class-based-views/mixins-date-based.txt index 31697226f9..471e222a6e 100644 --- a/docs/ref/class-based-views/mixins-date-based.txt +++ b/docs/ref/class-based-views/mixins-date-based.txt @@ -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>`. diff --git a/docs/ref/class-based-views/mixins-editing.txt b/docs/ref/class-based-views/mixins-editing.txt index 9cde8b9834..4b20e9498c 100644 --- a/docs/ref/class-based-views/mixins-editing.txt +++ b/docs/ref/class-based-views/mixins-editing.txt @@ -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`` diff --git a/docs/ref/class-based-views/mixins-multiple-object.txt b/docs/ref/class-based-views/mixins-multiple-object.txt index 8f6fcb8d48..52d5d976db 100644 --- a/docs/ref/class-based-views/mixins-multiple-object.txt +++ b/docs/ref/class-based-views/mixins-multiple-object.txt @@ -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() diff --git a/docs/ref/class-based-views/mixins-simple.txt b/docs/ref/class-based-views/mixins-simple.txt index d220737340..b865308491 100644 --- a/docs/ref/class-based-views/mixins-simple.txt +++ b/docs/ref/class-based-views/mixins-simple.txt @@ -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 diff --git a/docs/ref/class-based-views/mixins-single-object.txt b/docs/ref/class-based-views/mixins-single-object.txt index 2801b9964b..4fb33f6ce8 100644 --- a/docs/ref/class-based-views/mixins-single-object.txt +++ b/docs/ref/class-based-views/mixins-single-object.txt @@ -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`` |
