Skip to content

Commit bdb32bc

Browse files
chore: add missing docstrings
1 parent 4c1365d commit bdb32bc

13 files changed

+40
-0
lines changed

src/supermemory/types/document_get_response.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212

1313
class DocumentGetResponse(BaseModel):
14+
"""Document object"""
15+
1416
id: str
1517
"""Unique identifier of the document."""
1618

src/supermemory/types/document_list_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,14 @@ class DocumentListParams(TypedDict, total=False):
4242

4343

4444
class FiltersOr(TypedDict, total=False):
45+
"""OR"""
46+
4547
or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
4648

4749

4850
class FiltersAnd(TypedDict, total=False):
51+
"""AND"""
52+
4953
and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
5054

5155

src/supermemory/types/document_list_response.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ class Memory(BaseModel):
7979

8080

8181
class Pagination(BaseModel):
82+
"""Pagination metadata"""
83+
8284
current_page: float = FieldInfo(alias="currentPage")
8385

8486
total_items: float = FieldInfo(alias="totalItems")
@@ -89,6 +91,8 @@ class Pagination(BaseModel):
8991

9092

9193
class DocumentListResponse(BaseModel):
94+
"""List of documents"""
95+
9296
memories: List[Memory]
9397

9498
pagination: Pagination

src/supermemory/types/memory_get_response.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212

1313
class MemoryGetResponse(BaseModel):
14+
"""Document object"""
15+
1416
id: str
1517
"""Unique identifier of the document."""
1618

src/supermemory/types/memory_list_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,14 @@ class MemoryListParams(TypedDict, total=False):
4242

4343

4444
class FiltersOr(TypedDict, total=False):
45+
"""OR"""
46+
4547
or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
4648

4749

4850
class FiltersAnd(TypedDict, total=False):
51+
"""AND"""
52+
4953
and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
5054

5155

src/supermemory/types/memory_list_response.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ class Memory(BaseModel):
7979

8080

8181
class Pagination(BaseModel):
82+
"""Pagination metadata"""
83+
8284
current_page: float = FieldInfo(alias="currentPage")
8385

8486
total_items: float = FieldInfo(alias="totalItems")
@@ -89,6 +91,8 @@ class Pagination(BaseModel):
8991

9092

9193
class MemoryListResponse(BaseModel):
94+
"""List of documents"""
95+
9296
memories: List[Memory]
9397

9498
pagination: Pagination

src/supermemory/types/profile_response.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ class Profile(BaseModel):
1818

1919

2020
class SearchResults(BaseModel):
21+
"""Search results if a search query was provided"""
22+
2123
results: List[object]
2224
"""Search results for the provided query"""
2325

src/supermemory/types/search_documents_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,14 @@ class SearchDocumentsParams(TypedDict, total=False):
8383

8484

8585
class FiltersOr(TypedDict, total=False):
86+
"""OR"""
87+
8688
or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
8789

8890

8991
class FiltersAnd(TypedDict, total=False):
92+
"""AND"""
93+
9094
and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
9195

9296

src/supermemory/types/search_documents_response.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111

1212
class ResultChunk(BaseModel):
13+
"""Matching content chunk"""
14+
1315
content: str
1416
"""Content of the matching chunk"""
1517

src/supermemory/types/search_execute_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,14 @@ class SearchExecuteParams(TypedDict, total=False):
8383

8484

8585
class FiltersOr(TypedDict, total=False):
86+
"""OR"""
87+
8688
or_: Required[Annotated[Iterable[object], PropertyInfo(alias="OR")]]
8789

8890

8991
class FiltersAnd(TypedDict, total=False):
92+
"""AND"""
93+
9094
and_: Required[Annotated[Iterable[object], PropertyInfo(alias="AND")]]
9195

9296

0 commit comments

Comments
 (0)