Always use parentheses when documenting a method with no arguments.
This commit is contained in:
Baptiste Mispelon
parent
79e1d6ebd7
commit
05d36dc06e
|
|
@ -193,7 +193,7 @@ card values plus their suits; 104 characters in total.
|
|||
you want your fields to be more strict about the options they select, or to
|
||||
use the simpler, more permissive behavior of the current fields.
|
||||
|
||||
.. method:: Field.__init__
|
||||
.. method:: Field.__init__()
|
||||
|
||||
The :meth:`~django.db.models.Field.__init__` method takes the following
|
||||
parameters:
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@ your function. Example:
|
|||
Registering custom filters
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. method:: django.template.Library.filter
|
||||
.. method:: django.template.Library.filter()
|
||||
|
||||
Once you've written your filter definition, you need to register it with
|
||||
your ``Library`` instance, to make it available to Django's template language:
|
||||
|
|
@ -157,7 +157,7 @@ are described in :ref:`filters and auto-escaping <filters-auto-escaping>` and
|
|||
Template filters that expect strings
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. method:: django.template.defaultfilters.stringfilter
|
||||
.. method:: django.template.defaultfilters.stringfilter()
|
||||
|
||||
If you're writing a template filter that only expects a string as the first
|
||||
argument, you should use the decorator ``stringfilter``. This will
|
||||
|
|
@ -750,7 +750,7 @@ cannot resolve the string passed to it in the current context of the page.
|
|||
Simple tags
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. method:: django.template.Library.simple_tag
|
||||
.. method:: django.template.Library.simple_tag()
|
||||
|
||||
Many template tags take a number of arguments -- strings or template variables
|
||||
-- and return a string after doing some processing based solely on
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -219,17 +219,17 @@ You can edit it multiple times.
|
|||
|
||||
Example: ``fav_color = request.session.pop('fav_color')``
|
||||
|
||||
.. method:: keys
|
||||
.. method:: keys()
|
||||
|
||||
.. method:: items
|
||||
.. method:: items()
|
||||
|
||||
.. method:: setdefault
|
||||
.. method:: setdefault()
|
||||
|
||||
.. method:: clear
|
||||
.. method:: clear()
|
||||
|
||||
It also has these methods:
|
||||
|
||||
.. method:: flush
|
||||
.. method:: flush()
|
||||
|
||||
Delete the current session data from the session and regenerate the
|
||||
session key value that is sent back to the user in the cookie. This is
|
||||
|
|
@ -237,21 +237,21 @@ You can edit it multiple times.
|
|||
accessed again from the user's browser (for example, the
|
||||
:func:`django.contrib.auth.logout()` function calls it).
|
||||
|
||||
.. method:: set_test_cookie
|
||||
.. method:: set_test_cookie()
|
||||
|
||||
Sets a test cookie to determine whether the user's browser supports
|
||||
cookies. Due to the way cookies work, you won't be able to test this
|
||||
until the user's next page request. See `Setting test cookies`_ below for
|
||||
more information.
|
||||
|
||||
.. method:: test_cookie_worked
|
||||
.. method:: test_cookie_worked()
|
||||
|
||||
Returns either ``True`` or ``False``, depending on whether the user's
|
||||
browser accepted the test cookie. Due to the way cookies work, you'll
|
||||
have to call ``set_test_cookie()`` on a previous, separate page request.
|
||||
See `Setting test cookies`_ below for more information.
|
||||
|
||||
.. method:: delete_test_cookie
|
||||
.. method:: delete_test_cookie()
|
||||
|
||||
Deletes the test cookie. Use this to clean up after yourself.
|
||||
|
||||
|
|
@ -280,7 +280,7 @@ You can edit it multiple times.
|
|||
purposes. Session expiration is computed from the last time the
|
||||
session was *modified*.
|
||||
|
||||
.. method:: get_expiry_age
|
||||
.. method:: get_expiry_age()
|
||||
|
||||
Returns the number of seconds until this session expires. For sessions
|
||||
with no custom expiration (or those set to expire at browser close), this
|
||||
|
|
@ -295,7 +295,7 @@ You can edit it multiple times.
|
|||
``None``. Defaults to the value stored in the session by
|
||||
:meth:`set_expiry`, if there is one, or ``None``.
|
||||
|
||||
.. method:: get_expiry_date
|
||||
.. method:: get_expiry_date()
|
||||
|
||||
Returns the date this session will expire. For sessions with no custom
|
||||
expiration (or those set to expire at browser close), this will equal the
|
||||
|
|
@ -303,17 +303,17 @@ You can edit it multiple times.
|
|||
|
||||
This function accepts the same keyword arguments as :meth:`get_expiry_age`.
|
||||
|
||||
.. method:: get_expire_at_browser_close
|
||||
.. method:: get_expire_at_browser_close()
|
||||
|
||||
Returns either ``True`` or ``False``, depending on whether the user's
|
||||
session cookie will expire when the user's Web browser is closed.
|
||||
|
||||
.. method:: clear_expired
|
||||
.. method:: clear_expired()
|
||||
|
||||
Removes expired sessions from the session store. This class method is
|
||||
called by :djadmin:`clearsessions`.
|
||||
|
||||
.. method:: cycle_key
|
||||
.. method:: cycle_key()
|
||||
|
||||
Creates a new session key while retaining the current session data.
|
||||
:func:`django.contrib.auth.login()` calls this method to mitigate against
|
||||
|
|
|
|||
|
|
@ -1036,7 +1036,7 @@ If ``multi_db=True``, fixtures are loaded into all databases.
|
|||
Overriding settings
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. method:: SimpleTestCase.settings
|
||||
.. method:: SimpleTestCase.settings()
|
||||
|
||||
For testing purposes it's often useful to change a setting temporarily and
|
||||
revert to the original value after running the testing code. For this use case
|
||||
|
|
@ -1061,7 +1061,7 @@ Django provides a standard Python context manager (see :pep:`343`) called
|
|||
This example will override the :setting:`LOGIN_URL` setting for the code
|
||||
in the ``with`` block and reset its value to the previous state afterwards.
|
||||
|
||||
.. method:: SimpleTestCase.modify_settings
|
||||
.. method:: SimpleTestCase.modify_settings()
|
||||
|
||||
.. versionadded:: 1.7
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue