Merge pull request #1860 from bagerard/improve_doc_EmbeddedDocumentList.filter

Improve doc of EmbeddedDocumentList.filter,
This commit is contained in:
erdenezul 2018-08-31 11:35:25 +08:00 committed by GitHub
commit 60fe919992
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

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.*