Fix docstring (#766)

* fix docstring for update operator * fix docstring for array operator
BeanieODM · Nov 5, 2023 · 12f4a14 · 12f4a14
1 parent 0add350
commit 12f4a14
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/beanie/odm/operators/update/array.py b/beanie/odm/operators/update/array.py
@@ -22,7 +22,7 @@ class AddToSet(BaseUpdateArrayOperator):
     class Sample(Document):
         results: List[int]
 
-    AddToSet({Sample.results, 2})
+    AddToSet({Sample.results: 2})
     ```
 
     Will return query object like
@@ -48,7 +48,7 @@ class Pop(BaseUpdateArrayOperator):
     class Sample(Document):
         results: List[int]
 
-    Pop({Sample.results, 2})
+    Pop({Sample.results: 2})
     ```
 
     Will return query object like
@@ -74,7 +74,7 @@ class Pull(BaseUpdateArrayOperator):
     class Sample(Document):
         results: List[int]
 
-    Pull(In(Sample.result, [1,2,3,4,5])
+    Pull(In(Sample.result: [1,2,3,4,5])
     ```
 
     Will return query object like

diff --git a/beanie/odm/operators/update/general.py b/beanie/odm/operators/update/general.py
@@ -81,7 +81,7 @@ class CurrentDate(BaseUpdateGeneralOperator):
     class Sample(Document):
         ts: datetime
 
-    CurrentDate({Sample.ts, True})
+    CurrentDate({Sample.ts: True})
     ```
 
     Will return query object like
@@ -107,7 +107,7 @@ class Inc(BaseUpdateGeneralOperator):
     class Sample(Document):
         one: int
 
-    Inc({Sample.one, 2})
+    Inc({Sample.one: 2})
     ```
 
     Will return query object like
@@ -133,7 +133,7 @@ class Min(BaseUpdateGeneralOperator):
     class Sample(Document):
         one: int
 
-    Min({Sample.one, 2})
+    Min({Sample.one: 2})
     ```
 
     Will return query object like
@@ -159,7 +159,7 @@ class Max(BaseUpdateGeneralOperator):
     class Sample(Document):
         one: int
 
-    Max({Sample.one, 2})
+    Max({Sample.one: 2})
     ```
 
     Will return query object like
@@ -185,7 +185,7 @@ class Mul(BaseUpdateGeneralOperator):
     class Sample(Document):
         one: int
 
-    Mul({Sample.one, 2})
+    Mul({Sample.one: 2})
     ```
 
     Will return query object like