From a67bf4be35413b7c000f34b93291b632f903e085 Mon Sep 17 00:00:00 2001 From: Anton Strogonoff Date: Wed, 19 Aug 2015 02:01:36 +0600 Subject: [PATCH] [1.8.x] Used consistent capitalization and hyphenation of "class-based views" in docs. Backport of 20787b5c298d97dda10286a942a788423fed483f from master --- docs/internals/team.txt | 4 ++-- docs/ref/class-based-views/index.txt | 2 +- docs/ref/contrib/messages.txt | 2 +- docs/ref/utils.txt | 2 +- docs/topics/class-based-views/generic-display.txt | 2 +- docs/topics/class-based-views/index.txt | 2 +- docs/topics/class-based-views/intro.txt | 4 ++-- docs/topics/class-based-views/mixins.txt | 5 ++--- docs/topics/http/urls.txt | 2 +- docs/topics/testing/tools.txt | 2 +- 10 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/internals/team.txt b/docs/internals/team.txt index 7368ffbaf5..0c68730634 100644 --- a/docs/internals/team.txt +++ b/docs/internals/team.txt @@ -376,9 +376,9 @@ Donald Stufft Marc Tamlyn Marc started life on the web using Django 1.2 back in 2010, and has never - looked back. He was involved with rewriting the class based view + looked back. He was involved with rewriting the class-based view documentation at DjangoCon EU 2012, and also helped to develop `CCBV`_, an - additional class based view reference tool. + additional class-based view reference tool. Marc is currently a full-time parent, part-time developer, and lives in Oxford, UK. diff --git a/docs/ref/class-based-views/index.txt b/docs/ref/class-based-views/index.txt index fa4288a035..b5ba62dbc3 100644 --- a/docs/ref/class-based-views/index.txt +++ b/docs/ref/class-based-views/index.txt @@ -1,5 +1,5 @@ ============================== -Built-in Class-based views API +Built-in class-based views API ============================== Class-based views API reference. For introductory material, see the diff --git a/docs/ref/contrib/messages.txt b/docs/ref/contrib/messages.txt index 80386b5944..6a495a966c 100644 --- a/docs/ref/contrib/messages.txt +++ b/docs/ref/contrib/messages.txt @@ -352,7 +352,7 @@ example:: use one of the ``add_message`` family of methods. It does not hide failures that may occur for other reasons. -Adding messages in Class Based Views +Adding messages in class-based views ------------------------------------ .. class:: views.SuccessMessageMixin diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index b803ac4ff7..2bd812cdfa 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -176,7 +176,7 @@ The functions defined in this module share the following properties: .. function:: method_decorator(decorator) Converts a function decorator into a method decorator. See :ref:`decorating - class based views` for example usage. + class-based views` for example usage. .. function:: decorator_from_middleware(middleware_class) diff --git a/docs/topics/class-based-views/generic-display.txt b/docs/topics/class-based-views/generic-display.txt index f3d922ab3a..ed5c593e95 100644 --- a/docs/topics/class-based-views/generic-display.txt +++ b/docs/topics/class-based-views/generic-display.txt @@ -1,7 +1,7 @@ .. _Generic views: ================================== -Built-in Class-based generic views +Built-in class-based generic views ================================== Writing Web applications can be monotonous, because we repeat certain patterns diff --git a/docs/topics/class-based-views/index.txt b/docs/topics/class-based-views/index.txt index dc77f04721..dcc0784ada 100644 --- a/docs/topics/class-based-views/index.txt +++ b/docs/topics/class-based-views/index.txt @@ -84,7 +84,7 @@ views:: For more information on how to use the built in generic views, consult the next -topic on :doc:`generic class based views`. +topic on :doc:`generic class-based views`. .. _supporting-other-http-methods: diff --git a/docs/topics/class-based-views/intro.txt b/docs/topics/class-based-views/intro.txt index 6c1ec9233e..eb3cbf3b54 100644 --- a/docs/topics/class-based-views/intro.txt +++ b/docs/topics/class-based-views/intro.txt @@ -1,5 +1,5 @@ ================================= -Introduction to Class-based views +Introduction to class-based views ================================= Class-based views provide an alternative way to implement views as Python @@ -43,7 +43,7 @@ The toolkit of base classes and mixins that Django uses to build class-based generic views are built for maximum flexibility, and as such have many hooks in the form of default method implementations and attributes that you are unlikely to be concerned with in the simplest use cases. For example, instead of -limiting you to a class based attribute for ``form_class``, the implementation +limiting you to a class-based attribute for ``form_class``, the implementation uses a ``get_form`` method, which calls a ``get_form_class`` method, which in its default implementation just returns the ``form_class`` attribute of the class. This gives you several options for specifying what form to use, from a diff --git a/docs/topics/class-based-views/mixins.txt b/docs/topics/class-based-views/mixins.txt index c8ad7ec335..1dd8b04bb5 100644 --- a/docs/topics/class-based-views/mixins.txt +++ b/docs/topics/class-based-views/mixins.txt @@ -204,11 +204,10 @@ the box. understandable to someone else coming to it later, and with fewer interactions to worry about you will save yourself some thinking. (Of course, you can always dip into Django's implementation of the generic - class based views for inspiration on how to tackle problems.) + class-based views for inspiration on how to tackle problems.) .. _method resolution order: https://www.python.org/download/releases/2.3/mro/ - Using SingleObjectMixin with View --------------------------------- @@ -593,7 +592,7 @@ views as separate as possible. More than just HTML =================== -Where class based views shine is when you want to do the same thing many times. +Where class-based views shine is when you want to do the same thing many times. Suppose you're writing an API, and every view should return JSON instead of rendered HTML. diff --git a/docs/topics/http/urls.txt b/docs/topics/http/urls.txt index 607efe7308..c33fba72a2 100644 --- a/docs/topics/http/urls.txt +++ b/docs/topics/http/urls.txt @@ -52,7 +52,7 @@ algorithm the system follows to determine which Python code to execute: one that matches the requested URL. 4. Once one of the regexes matches, Django imports and calls the given view, - which is a simple Python function (or a :doc:`class based view + which is a simple Python function (or a :doc:`class-based view `). The view gets passed the following arguments: diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt index 7d1bbaa82c..e135bdf64d 100644 --- a/docs/topics/testing/tools.txt +++ b/docs/topics/testing/tools.txt @@ -472,7 +472,7 @@ Specifically, a ``Response`` object has the following attributes: # my_view here is a function based view self.assertEqual(response.resolver_match.func, my_view) - # class based views need to be compared by name, as the functions + # class-based views need to be compared by name, as the functions # generated by as_view() won't be equal self.assertEqual(response.resolver_match.func.__name__, MyView.as_view().__name__)