Skip to content

Commit

Permalink
Merge pull request carltongibson#351 from pilnujemy/fix-docs-typo
Browse files Browse the repository at this point in the history
Fix typo in docs
  • Loading branch information
Carlton Gibson committed Jan 11, 2016
2 parents e1f40b0 + 48f34c9 commit 17744f8
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'classic'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down Expand Up @@ -183,7 +183,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('asd', 'django-filter.tex', u'django-filter Documentation',
('index', 'django-filter.tex', u'django-filter Documentation',
u'Alex Gaynor and others.', 'manual'),
]

Expand Down Expand Up @@ -213,7 +213,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('asd', 'django-filter', u'django-filter Documentation',
('index', 'django-filter', u'django-filter Documentation',
[u'Alex Gaynor and others.'], 1)
]

Expand All @@ -227,7 +227,7 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('asd', 'django-filter', u'django-filter Documentation',
('index', 'django-filter', u'django-filter Documentation',
u'Alex Gaynor and others.', 'django-filter', 'One line description of project.',
'Miscellaneous'),
]
Expand Down
2 changes: 1 addition & 1 deletion docs/ref/fields.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ You may set ``input_formats`` to your list of required formats as per the `DateT
f.input_formats = [IsoDateTimeField.ISO_8601] + DateTimeField.input_formats


.. _`DateTimeField Docs`:https://docs.djangoproject.com/en/1.8/ref/forms/fields/#django.forms.DateTimeField.input_formats
.. _`DateTimeField Docs`: https://docs.djangoproject.com/en/1.8/ref/forms/fields/#django.forms.DateTimeField.input_formats

4 changes: 2 additions & 2 deletions docs/ref/filters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -308,13 +308,13 @@ A boolean value that specifies whether the Filter should use ``filter`` or ``exc
Defaults to ``False``.

ModelChoiceFilter and ModelMultipleChoiceFilter arguments
--------------
---------------------------------------------------------

These arguments apply specifically to ModelChoiceFiler and
ModelMultipleChoiceFilter only.

``queryset``
~~~~~~~~~~~
~~~~~~~~~~~~

``ModelChoiceFilter`` and ``ModelMultipleChoiceFilter`` require a queryset to operate on which must be passed as a kwarg.

Expand Down
2 changes: 1 addition & 1 deletion docs/ref/widgets.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ arguments.
This widget renders each option as a link, instead of an actual <input>. It has
one method that you can override for additional customizability.
``option_string()`` should return a string with 3 Python keyword argument
placeholders::
placeholders:

1. ``attrs``: This is a string with all the attributes that will be on the
final ``<a>`` tag.
Expand Down
8 changes: 6 additions & 2 deletions docs/usage.txt
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ set to ``STRICTNESS.RETURN_NO_RESULTS`` meaning that an empty queryset is
returned if any field contains an invalid value. You can loosen this behavior
by setting ``strict`` to ``STRICTNESS.IGNORE`` which will effectively ignore a
filter field if its value is invalid. A third option of
``STRICTNESS.RAISE_VALIDATION_ERROR`` will cause a ``ValidationError` to be
``STRICTNESS.RAISE_VALIDATION_ERROR`` will cause a ``ValidationError`` to be
raised if any field contains an invalid value.

Overriding ``FilterSet`` methods
Expand Down Expand Up @@ -380,8 +380,11 @@ Choices help text

If you want the ``ChoiceField`` created from `LOOKUP_TYPES` to have human-friendly options you can do the following:

from django_filters import filters
::

# filters.py
from django_filters import filters

filters.LOOKUP_TYPES = [
('', '---------'),
('exact', 'Is equal to'),
Expand All @@ -395,3 +398,4 @@ If you want the ``ChoiceField`` created from `LOOKUP_TYPES` to have human-friend
('contains', 'Contains'),
('not_contains', 'Does not contain'),
]

0 comments on commit 17744f8

Please sign in to comment.