From 705abf313933b272381a4c72ec1bbf14751c54c4 Mon Sep 17 00:00:00 2001 From: Joan Fontanals Martinez Date: Thu, 24 Aug 2023 08:33:47 +0200 Subject: [PATCH 1/2] docs: improve filtering docstrings Signed-off-by: Joan Fontanals Martinez --- docarray/utils/filter.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docarray/utils/filter.py b/docarray/utils/filter.py index 5b7daa1e6f2..cc139988901 100644 --- a/docarray/utils/filter.py +++ b/docarray/utils/filter.py @@ -13,7 +13,8 @@ def filter_docs( ) -> AnyDocArray: """ Filter the Documents in the index according to the given filter query. - + The query follows the syntax of MongoDB query language (https://www.mongodb.com/docs/manual/tutorial/query-documents/#specify-conditions-using-query-operators). + You can see a list of the supported operators here (https://www.mongodb.com/docs/manual/reference/operator/query/#std-label-query-selectors) --- From b0d370b9ff96485f64df57e722e8ff18310a49e6 Mon Sep 17 00:00:00 2001 From: Joan Fontanals Date: Thu, 24 Aug 2023 09:08:54 +0200 Subject: [PATCH 2/2] docs: update docarray/utils/filter.py Co-authored-by: Scott Martens <70647348+scott-martens@users.noreply.github.com> Signed-off-by: Joan Fontanals --- docarray/utils/filter.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docarray/utils/filter.py b/docarray/utils/filter.py index cc139988901..4445adf827d 100644 --- a/docarray/utils/filter.py +++ b/docarray/utils/filter.py @@ -13,7 +13,7 @@ def filter_docs( ) -> AnyDocArray: """ Filter the Documents in the index according to the given filter query. - The query follows the syntax of MongoDB query language (https://www.mongodb.com/docs/manual/tutorial/query-documents/#specify-conditions-using-query-operators). + Filter queries use the same syntax as the MongoDB query language (https://www.mongodb.com/docs/manual/tutorial/query-documents/#specify-conditions-using-query-operators). You can see a list of the supported operators here (https://www.mongodb.com/docs/manual/reference/operator/query/#std-label-query-selectors)