Improve docs

jefersondaniel · Apr 25, 2024 · a82447a · a82447a
1 parent 3123ed8
commit a82447a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ class Bar(BaseModel):
    banana: str = 'y'
 
 class Spam(BaseModel):
+   # PydanticObjectId is an alias to Annotated[ObjectId, ObjectIdAnnotation]
    id: Optional[PydanticObjectId] = None
    foo: Foo
    bars: List[Bar]

diff --git a/pydantic_mongo/__init__.py b/pydantic_mongo/__init__.py
@@ -1,5 +1,5 @@
 from .abstract_repository import AbstractRepository
-from .fields import ObjectIdField, PydanticObjectId
+from .fields import ObjectIdAnnotation, ObjectIdField, PydanticObjectId
 from .version import __version__  # noqa: F401
 
-__all__ = ["ObjectIdField", "PydanticObjectId", "AbstractRepository"]
+__all__ = ["AbstractRepository", "ObjectIdField", "ObjectIdAnnotation", "PydanticObjectId"]