diff options
| author | Baptiste Mispelon <bmispelon@gmail.com> | 2014-01-22 22:26:10 +0100 |
|---|---|---|
| committer | Baptiste Mispelon <bmispelon@gmail.com> | 2014-01-22 22:26:10 +0100 |
| commit | 05d36dc06e6d767bb28993c65a54b703f319a386 (patch) | |
| tree | ed2af78f1307dda6b029d866f40bf2244705733e /docs/ref | |
| parent | 79e1d6ebd70898d514a44b85648e3d24104c4243 (diff) | |
Always use parentheses when documenting a method with no arguments.
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/comments/moderation.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/formtools/form-preview.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/formtools/form-wizard.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/gdal.txt | 16 | ||||
| -rw-r--r-- | docs/ref/forms/api.txt | 8 | ||||
| -rw-r--r-- | docs/ref/forms/validation.txt | 2 | ||||
| -rw-r--r-- | docs/ref/template-response.txt | 2 |
7 files changed, 17 insertions, 17 deletions
diff --git a/docs/ref/contrib/comments/moderation.txt b/docs/ref/contrib/comments/moderation.txt index 5f0badfadb..2f14064191 100644 --- a/docs/ref/contrib/comments/moderation.txt +++ b/docs/ref/contrib/comments/moderation.txt @@ -222,7 +222,7 @@ models with an instance of the subclass. :func:`moderator.unregister` methods detailed above, the following methods on :class:`Moderator` can be overridden to achieve customized behavior: - .. method:: connect + .. method:: connect() Determines how moderation is set up globally. The base implementation in diff --git a/docs/ref/contrib/formtools/form-preview.txt b/docs/ref/contrib/formtools/form-preview.txt index b86cc4dc90..6a30fe9d9f 100644 --- a/docs/ref/contrib/formtools/form-preview.txt +++ b/docs/ref/contrib/formtools/form-preview.txt @@ -111,7 +111,7 @@ default templates. Advanced ``FormPreview`` methods ================================ -.. method:: FormPreview.process_preview +.. method:: FormPreview.process_preview() Given a validated form, performs any extra processing before displaying the preview page, and saves any extra data in context. diff --git a/docs/ref/contrib/formtools/form-wizard.txt b/docs/ref/contrib/formtools/form-wizard.txt index ca11aef763..6a1e328ba8 100644 --- a/docs/ref/contrib/formtools/form-wizard.txt +++ b/docs/ref/contrib/formtools/form-wizard.txt @@ -229,7 +229,7 @@ Here's a full example template: Hooking the wizard into a URLconf --------------------------------- -.. method:: WizardView.as_view +.. method:: WizardView.as_view() Finally, we need to specify which forms to use in the wizard, and then deploy the new :class:`WizardView` object at a URL in the ``urls.py``. The diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt index 9655b2dc5a..29a2daab82 100644 --- a/docs/ref/contrib/gis/gdal.txt +++ b/docs/ref/contrib/gis/gdal.txt @@ -459,19 +459,19 @@ systems and coordinate transformation:: Constructs a :class:`Polygon` from the given bounding-box (a 4-tuple). - .. method:: __len__ + .. method:: __len__() Returns the number of points in a :class:`LineString`, the number of rings in a :class:`Polygon`, or the number of geometries in a :class:`GeometryCollection`. Not applicable to other geometry types. - .. method:: __iter__ + .. method:: __iter__() Iterates over the points in a :class:`LineString`, the rings in a :class:`Polygon`, or the geometries in a :class:`GeometryCollection`. Not applicable to other geometry types. - .. method:: __getitem__ + .. method:: __getitem__() Returns the point at the specified index for a :class:`LineString`, the interior ring at the specified index for a :class:`Polygon`, or the geometry @@ -677,7 +677,7 @@ systems and coordinate transformation:: Returns ``True`` if this geometry overlaps the other, otherwise returns ``False``. - .. method:: boundary + .. method:: boundary() The boundary of this geometry, as a new :class:`OGRGeometry` object. @@ -686,22 +686,22 @@ systems and coordinate transformation:: The smallest convex polygon that contains this geometry, as a new :class:`OGRGeometry` object. - .. method:: difference + .. method:: difference() Returns the region consisting of the difference of this geometry and the other, as a new :class:`OGRGeometry` object. - .. method:: intersection + .. method:: intersection() Returns the region consisting of the intersection of this geometry and the other, as a new :class:`OGRGeometry` object. - .. method:: sym_difference + .. method:: sym_difference() Returns the region consisting of the symmetric difference of this geometry and the other, as a new :class:`OGRGeometry` object. - .. method:: union + .. method:: union() Returns the region consisting of the union of this geometry and the other, as a new :class:`OGRGeometry` object. diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index c8f302b924..fbc025f18c 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -396,7 +396,7 @@ a form object, and each rendering method returns a Unicode object. ``as_p()`` ~~~~~~~~~~ -.. method:: Form.as_p +.. method:: Form.as_p() ``as_p()`` renders the form as a series of ``<p>`` tags, with each ``<p>`` containing one field:: @@ -413,7 +413,7 @@ containing one field:: ``as_ul()`` ~~~~~~~~~~~ -.. method:: Form.as_ul +.. method:: Form.as_ul() ``as_ul()`` renders the form as a series of ``<li>`` tags, with each ``<li>`` containing one field. It does *not* include the ``<ul>`` or @@ -432,7 +432,7 @@ flexibility:: ``as_table()`` ~~~~~~~~~~~~~~ -.. method:: Form.as_table +.. method:: Form.as_table() Finally, ``as_table()`` outputs the form as an HTML ``<table>``. This is exactly the same as ``print``. In fact, when you ``print`` a form object, @@ -864,7 +864,7 @@ form data *and* file data:: Testing for multipart forms ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. method:: Form.is_multipart +.. method:: Form.is_multipart() If you're writing reusable views or templates, you may not know ahead of time whether your form is a multipart form or not. The ``is_multipart()`` method diff --git a/docs/ref/forms/validation.txt b/docs/ref/forms/validation.txt index a07cb93183..569e7e77e7 100644 --- a/docs/ref/forms/validation.txt +++ b/docs/ref/forms/validation.txt @@ -329,7 +329,7 @@ from , which is turned into a form-wide error that is available through the Cleaning and validating fields that depend on each other ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. method:: django.forms.Form.clean +.. method:: django.forms.Form.clean() Suppose we add another requirement to our contact form: if the ``cc_myself`` field is ``True``, the ``subject`` must contain the word ``"help"``. We are diff --git a/docs/ref/template-response.txt b/docs/ref/template-response.txt index 150ebc73d9..36b710426c 100644 --- a/docs/ref/template-response.txt +++ b/docs/ref/template-response.txt @@ -99,7 +99,7 @@ Methods Override this method in order to customize template rendering. -.. method:: SimpleTemplateResponse.add_post_render_callback +.. method:: SimpleTemplateResponse.add_post_render_callback() Add a callback that will be invoked after rendering has taken place. This hook can be used to defer certain processing |
