Improve doc of EmbeddedDocumentList.filter and clarify that it does not supports operators like __lte, __gte, etc

This commit is contained in:
Bastien Gérard 2018-08-30 21:50:03 +02:00
parent 9ad959a478
commit 4779106139

View File

@ -234,6 +234,9 @@ class EmbeddedDocumentList(BaseList):
Filters the list by only including embedded documents with the Filters the list by only including embedded documents with the
given keyword arguments. given keyword arguments.
This method only supports simple comparison (e.g: .filter(name='John Doe'))
and does not support operators like __gte, __lte, __icontains like queryset.filter does
:param kwargs: The keyword arguments corresponding to the fields to :param kwargs: The keyword arguments corresponding to the fields to
filter on. *Multiple arguments are treated as if they are ANDed filter on. *Multiple arguments are treated as if they are ANDed
together.* together.*