docs: added/changed doc-comments.

Author: joshorr

.gitignore

@@ -1,7 +1,7 @@
 # Custom Ones
 
 /scripts
-
+/api
 
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

pydantic_partials/config.py

@@ -9,7 +9,7 @@ class PartialConfigDict(ConfigDict):
     """
     Defaults to `True`.
     
-    If `True` (default): When class is created, all required attributes will be made `Partial`,
+    - If `True` (default): When class is created, all required attributes will be made `Partial`,
         and their default set to `Missing`. This means that all attributes that don't have any
         default or default_factory defined will automatically have `MissingType`/`LazyType` added
         to their annotation and field default set to `Missing`/`Lazy`.
@@ -19,7 +19,7 @@ class PartialConfigDict(ConfigDict):
         This allows Pydantic to create an instance of the model without a value defined
         for partial fields.
     
-    If `False`: Class won't automatically add `Partial` fields.
+    - If `False`: Class won't automatically add `Partial` fields.
         Instead adding them to individual fields will be up to the user.
         
         The default value of any fields set by user to be `Partial` will still be adjusted

pydantic_partials/meta.py

@@ -15,7 +15,11 @@
 
 
 # metaclass to make all fields in a model optional, useful for PATCH requests
-class _PartialMeta(ModelMetaclass):
+class PartialMeta(ModelMetaclass):
+    """ Metaclass of `pydantic_partials.partial.PartialModel`, used to support partial fields,
+        including the ability ot automatically apply `pydantic_partials.partial.Partial`[...] to fields
+        via `pydantic_partials.config.PartialConfigDict.auto_partials` configuration option.
+    """
     model_partial_fields: typing.ClassVar[set[str]]
     """ Set of strings representing field names that can be missing from validation/serialization.
         If they are missing, they will return the `Missing` sentinel value and the field will be entirely
@@ -53,7 +57,7 @@ def __new__(
         """
 
         Args:
-            auto_partials: For more details see `pydantic_partials.config.PartialConfigDict.auto_partial`.
+            auto_partials: For more details see `pydantic_partials.config.PartialConfigDict.auto_partials`.
                 If `Default`: Inherit behavior from parent/model_config; otherwise defaults to `True`.
                 If `True` (default): Will automatically make all fields on the model `Partial`.
                 If `False`: User needs to mark individual fields as `Partial` where they want.

pydantic_partials/partial.py

@@ -3,7 +3,7 @@
 
 from pydantic import BaseModel, model_serializer, JsonValue
 
-from .meta import _PartialMeta
+from .meta import PartialMeta
 from .sentinels import Missing, MissingType
 
 from logging import getLogger
@@ -23,18 +23,25 @@ class PartialModel(
 
     # Need metaclass to examine fields for missing type
     # and also to auto-add missing type if desired.
-    metaclass=_PartialMeta,
+    metaclass=PartialMeta,
 
     # Needed so `Missing` default values will be validated and therefore the `PydanticOmit` will be
     # raised and inform Pydantic to ignore/omit the field value.
     validate_default=True
 ):
-    """ Class Args:
-            auto_partial: For more details see `pydantic_partials.config.PartialConfigDict.auto_partial`.
-                If `Default`: Inherit behavior from parent/model_config; otherwise defaults to `True`.
-                If `True` (default): Will automatically make all fields on the model `Partial`.
-                If `False`: User needs to mark individual fields as `Partial` where they want.
     """
+    Class Args:
+
+    - auto_partial: For more details see `pydantic_partials.config.PartialConfigDict.auto_partials`.
+        - If `Default`: Inherit behavior from parent/model_config; otherwise defaults to `True`.
+        - If `True` (default): Will automatically make all fields on the model `Partial`.
+        - If `False`: User needs to mark individual fields as `Partial` where they want.
+    """
+
+    def __init__(self, *args, **kwargs):
+        """ Pydantic partial model class, with ability to easily dynamically omit fields when serializing a model.
+        """
+        super().__init__(*args, **kwargs)
 
     if not typing.TYPE_CHECKING:
 

pydantic_partials/sentinels.py

@@ -6,7 +6,10 @@
 
 
 class MissingType(Sentinel):
-    # See (https://docs.pydantic.dev/latest/concepts/json_schema/#modifying-the-schema).
+    """ Class/Type of `Missing`, a sentinel that is used to indicate if a field is missing its value
+        in a `pydantic_partials.partial.PartialModel` subclass.
+    """
+    # Notes/See (https://docs.pydantic.dev/latest/concepts/json_schema/#modifying-the-schema).
 
     @classmethod
     def __get_pydantic_core_schema__(
@@ -41,6 +44,8 @@ def _serialize(value: Any) -> 'MissingType':
 
 
 Missing = MissingType()
+""" Returned as attribute value when attribute value is missing. Can also be set on attribute to indicate it's missing.
+"""
 
 T = TypeVar('T')
 

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "pydantic-partials"
 version = "1.0.0"
-description = "Pydantic partial model class, with ability to easily dynamically omit fields when seralizing a model."
+description = "Pydantic partial model class, with ability to easily dynamically omit fields when serializing a model."
 
 authors = ["Josh Orr <[email protected]>"]
 packages = [{include = "pydantic_partials"}]