#143 Update docstrings

Author: astropenguin

xarray_dataclasses/dataarray.py

@@ -1,3 +1,4 @@
+"""Submodule for DataArray creation."""
 __all__ = ["AsDataArray", "asdataarray"]
 
 

xarray_dataclasses/datamodel.py

@@ -1,3 +1,4 @@
+"""Submodule for data expression inside the package."""
 __all__ = ["DataModel"]
 
 
@@ -32,7 +33,7 @@
 AnyEntry = Union["AttrEntry", "DataEntry"]
 
 
-# constants
+# runtime classes
 class MissingType:
     """Singleton that indicates missing data."""
 
@@ -51,7 +52,6 @@ def __repr__(self) -> str:
 MISSING = MissingType()
 
 
-# runtime classes
 @dataclass(frozen=True)
 class AttrEntry:
     """Entry of an attribute (i.e. metadata)."""

xarray_dataclasses/dataoptions.py

@@ -1,3 +1,4 @@
+"""Submodule for customization of DataArray or Dataset creation."""
 __all__ = ["DataOptions"]
 
 

xarray_dataclasses/dataset.py

@@ -1,3 +1,4 @@
+"""Submodule for Dataset creation."""
 __all__ = ["AsDataset", "asdataset"]
 
 

xarray_dataclasses/typing.py

@@ -48,7 +48,7 @@
 )
 
 
-# type hints
+# type hints (private)
 PInit = ParamSpec("PInit")
 TAttr = TypeVar("TAttr")
 TDataClass = TypeVar("TDataClass", bound="DataClass[Any]")
@@ -86,7 +86,7 @@ def __init__(self, *args: PInit.args, **kwargs: PInit.kwargs) -> None:
     __dataclass_fields__: ClassVar[DataClassFields]
 
 
-# constants
+# type hints (public)
 class FieldType(Enum):
     """Annotation of xarray-related field hints."""
 
@@ -107,9 +107,8 @@ def annotates(self, hint: Any) -> bool:
         return self in get_args(hint)[1:]
 
 
-# public type hints
 Attr = Annotated[TAttr, FieldType.ATTR]
-"""Type hint to define attribute fields (``Attr[T]``).
+"""Type hint to define attribute fields (``Attr[TAttr]``).
 
 Example:
     ::
@@ -185,7 +184,7 @@ class Image(AsDataArray):
 Data = Annotated[Union[Collection[TDims, TDtype], TDtype], FieldType.DATA]
 """Type hint to define data fields (``Coordof[TDims, TDtype]``).
 
-Examples:
+Example:
     Exactly one data field is allowed in a DataArray class
     (the second and subsequent data fields are just ignored)::