add OmitIfNone reference code

crim-ca · Apr 5, 2024 · 4eb30da · 4eb30da
1 parent 4d57e41
commit 4eb30da
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/stac_model/base.py b/stac_model/base.py
@@ -17,7 +17,7 @@ class MLMBaseModel(BaseModel):
     """
     Allows wrapping any field with an annotation to drop it entirely if unset.
 
-    ```
+    ```python
     field: Annotated[Optional[<desiredType>], OmitIfNone] = None
     # or
     field: Annotated[<desiredType>, OmitIfNone] = None
@@ -26,6 +26,8 @@ class MLMBaseModel(BaseModel):
     ```
 
     It is important to use `MLMBaseModel`, otherwise the serializer will not be called and applied.
+
+    Reference: https://github.com/pydantic/pydantic/discussions/5461#discussioncomment-7503283
     """
     @model_serializer
     def model_serialize(self):