Skip to content

Commit edc0f19

Browse files
authored
Fix search method definition docs (#3)
Copypasta error when writing docs that included undefined params and impossible return types.
1 parent 3c6d662 commit edc0f19

File tree

1 file changed

+0
-36
lines changed

1 file changed

+0
-36
lines changed

docs/managers/index.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -329,65 +329,29 @@ search(
329329
order: str | None = None,
330330
as_id: bool = False,
331331
as_dict: bool = False,
332-
optional: bool = False,
333332
) -> list[Record]
334333
```
335334

336-
```python
337-
search(
338-
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
339-
fields: Iterable[str] | None = None,
340-
order: str | None = None,
341-
as_id: bool = False,
342-
as_dict: bool = False,
343-
optional: bool = True,
344-
) -> list[Record] | None
345-
```
346-
347335
```python
348336
search(
349337
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
350338
fields: Iterable[str] | None = None,
351339
order: str | None = None,
352340
as_id: bool = True,
353341
as_dict: bool = False,
354-
optional: bool = False,
355342
) -> list[int]
356343
```
357344

358-
```python
359-
search(
360-
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
361-
fields: Iterable[str] | None = None,
362-
order: str | None = None,
363-
as_id: bool = True,
364-
as_dict: bool = False,
365-
optional: bool = True,
366-
) -> list[int] | None
367-
```
368-
369345
```python
370346
search(
371347
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
372348
fields: Iterable[str] | None = None,
373349
order: str | None = None,
374350
as_id: bool = False,
375351
as_dict: bool = True,
376-
optional: bool = False,
377352
) -> list[dict[str, Any]]
378353
```
379354

380-
```python
381-
search(
382-
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
383-
fields: Iterable[str] | None = None,
384-
order: str | None = None,
385-
as_id: bool = False,
386-
as_dict: bool = True,
387-
optional: bool = True,
388-
) -> list[dict[str, Any]] | None
389-
```
390-
391355
Query the ERP for records, optionally defining
392356
filters to constrain the search and other parameters,
393357
and return the results.

0 commit comments

Comments
 (0)