From 8cb1b0d82ff99f860e9542e575bb1f04e54f42aa Mon Sep 17 00:00:00 2001 From: AppleGrew Date: Fri, 27 Sep 2013 20:04:06 +0530 Subject: [PATCH] Added doc to get_queryset. --- django_select2/fields.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/django_select2/fields.py b/django_select2/fields.py index 4ee0621..455fde8 100644 --- a/django_select2/fields.py +++ b/django_select2/fields.py @@ -145,6 +145,16 @@ class ModelResultJsonMixin(object): super(ModelResultJsonMixin, self).__init__(*args, **kwargs) def get_queryset(self): + """ + Returns the queryset. + + The default implementation returns the ``self.queryset``, which is usually the + one set by sub-classes at class-level. However, if that is ``None`` + then ``ValueError`` is thrown. + + :return: queryset + :rtype: :py:class:`django.db.models.QuerySet` + """ if self.queryset is None: raise ValueError('queryset is required.')