openstack/horizon
Code Issues Proposed changes

some FilterAction attributes don't show in docs

Browse Source 
Due to missing ':'. Also add FixedFilterAction to docs.

Change-Id: I2b2d07a7865d3073c7648a82ef653673ebae2bf9
Closes-Bug: #1409892
This commit is contained in:
Cindy Lu 2015-01-12 14:38:56 -08:00
parent ee711e5c11
commit d4764ea7ae
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/ref/tables.rst
View File

@ -81,6 +81,9 @@ Actions
.. autoclass:: FilterAction .. autoclass:: FilterAction
:members: :members:
.. autoclass:: FixedFilterAction
:members:
.. autoclass:: BatchAction .. autoclass:: BatchAction
:members: :members:

6
horizon/tables/actions.py
View File

@ -422,13 +422,13 @@ class FilterAction(BaseAction):
A string representing the name of the request parameter used for the A string representing the name of the request parameter used for the
search term. Default: ``"q"``. search term. Default: ``"q"``.
.. attribute: filter_type .. attribute:: filter_type
A string representing the type of this filter. If this is set to A string representing the type of this filter. If this is set to
``"server"`` then ``filter_choices`` must also be provided. ``"server"`` then ``filter_choices`` must also be provided.
Default: ``"query"``. Default: ``"query"``.
.. attribute: filter_choices .. attribute:: filter_choices
Required for server type filters. A tuple of tuples representing the Required for server type filters. A tuple of tuples representing the
filter options. Tuple composition should evaluate to (string, string, filter options. Tuple composition should evaluate to (string, string,
@ -439,7 +439,7 @@ class FilterAction(BaseAction):
type filters in general will need to be performed in the filter method. type filters in general will need to be performed in the filter method.
By default this attribute is not provided. By default this attribute is not provided.
.. attribute: needs_preloading .. attribute:: needs_preloading
If True, the filter function will be called for the initial If True, the filter function will be called for the initial
GET request with an empty ``filter_string``, regardless of the GET request with an empty ``filter_string``, regardless of the