Skip to content

Commit 8a62354

Browse files
committed
Updated the searchfield_api docs.
1 parent e68f19b commit 8a62354

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/searchfield_api.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ Included with Haystack are the following field types:
3232
* ``IntegerField``
3333
* ``MultiValueField``
3434

35+
And equivalent faceted versions:
36+
37+
* ``FacetBooleanField``
38+
* ``FacetCharField``
39+
* ``FacetDateField``
40+
* ``FacetDateTimeField``
41+
* ``FacetFloatField``
42+
* ``FacetIntegerField``
43+
* ``FacetMultiValueField``
44+
3545

3646
Usage
3747
=====
@@ -167,6 +177,14 @@ Example::
167177

168178
bio = CharField(use_template=True, template_name='myapp/data/bio.txt')
169179

180+
You can also provide a list of templates, as ``loader.select_template`` is used
181+
under the hood.
182+
183+
Example::
184+
185+
bio = CharField(use_template=True, template_name=['myapp/data/bio.txt', 'myapp/bio.txt', 'bio.txt'])
186+
187+
170188
``use_template``
171189
----------------
172190

@@ -187,7 +205,7 @@ Method Reference
187205
``__init__``
188206
------------
189207

190-
.. method:: SearchField.__init__(self, model_attr=None, use_template=False, template_name=None, document=False, indexed=True, stored=True, default=NOT_PROVIDED, null=False)
208+
.. method:: SearchField.__init__(self, model_attr=None, use_template=False, template_name=None, document=False, indexed=True, stored=True, faceted=False, default=NOT_PROVIDED, null=False, index_fieldname=None, facet_class=None, weight=1.0)
191209

192210
Instantiates a fresh ``SearchField`` instance.
193211

0 commit comments

Comments
 (0)