Skip to content

Commit e2dc1e4

Browse files
committed
Update docstrings
1 parent a7d2ad2 commit e2dc1e4

File tree

1 file changed

+14
-0
lines changed
  • bindings/python/pymongoarrow

1 file changed

+14
-0
lines changed

bindings/python/pymongoarrow/api.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ def aggregate_arrow_all(collection, pipeline, *, schema=None, allow_invalid=Fals
125125
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
126126
If the schema is not given, it will be inferred using the data in the
127127
result set.
128+
- `allow_invalid` (optional): If set to ``True``,
129+
results will have all fields that do not conform to the schema silently converted to NaN.
128130
129131
Additional keyword-arguments passed to this method will be passed
130132
directly to the underlying ``aggregate`` operation.
@@ -182,6 +184,8 @@ def find_pandas_all(collection, query, *, schema=None, allow_invalid=False, **kw
182184
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
183185
If the schema is not given, it will be inferred using the data in the
184186
result set.
187+
- `allow_invalid` (optional): If set to ``True``,
188+
results will have all fields that do not conform to the schema silently converted to NaN.
185189
186190
Additional keyword-arguments passed to this method will be passed
187191
directly to the underlying ``find`` operation.
@@ -205,6 +209,8 @@ def aggregate_pandas_all(collection, pipeline, *, schema=None, allow_invalid=Fal
205209
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
206210
If the schema is not given, it will be inferred using the data in the
207211
result set.
212+
- `allow_invalid` (optional): If set to ``True``,
213+
results will have all fields that do not conform to the schema silently converted to NaN.
208214
209215
Additional keyword-arguments passed to this method will be passed
210216
directly to the underlying ``aggregate`` operation.
@@ -251,6 +257,8 @@ def find_numpy_all(collection, query, *, schema=None, allow_invalid=False, **kwa
251257
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
252258
If the schema is not given, it will be inferred using the data in the
253259
result set.
260+
- `allow_invalid` (optional): If set to ``True``,
261+
results will have all fields that do not conform to the schema silently converted to NaN.
254262
255263
Additional keyword-arguments passed to this method will be passed
256264
directly to the underlying ``find`` operation.
@@ -285,6 +293,8 @@ def aggregate_numpy_all(collection, pipeline, *, schema=None, allow_invalid=Fals
285293
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
286294
If the schema is not given, it will be inferred using the data in the
287295
result set.
296+
- `allow_invalid` (optional): If set to ``True``,
297+
results will have all fields that do not conform to the schema silently converted to NaN.
288298
289299
Additional keyword-arguments passed to this method will be passed
290300
directly to the underlying ``aggregate`` operation.
@@ -355,6 +365,8 @@ def find_polars_all(collection, query, *, schema=None, allow_invalid=False, **kw
355365
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
356366
If the schema is not given, it will be inferred using the data in the
357367
result set.
368+
- `allow_invalid` (optional): If set to ``True``,
369+
results will have all fields that do not conform to the schema silently converted to NaN.
358370
359371
Additional keyword-arguments passed to this method will be passed
360372
directly to the underlying ``find`` operation.
@@ -380,6 +392,8 @@ def aggregate_polars_all(collection, pipeline, *, schema=None, allow_invalid=Fal
380392
- `schema` (optional): Instance of :class:`~pymongoarrow.schema.Schema`.
381393
If the schema is not given, it will be inferred using the data in the
382394
result set.
395+
- `allow_invalid` (optional): If set to ``True``,
396+
results will have all fields that do not conform to the schema silently converted to NaN.
383397
384398
Additional keyword-arguments passed to this method will be passed
385399
directly to the underlying ``aggregate`` operation.

0 commit comments

Comments
 (0)