Doc improvements (#335)

dascore/core/attrs.py

@@ -77,7 +77,24 @@ def _get_dims(data_dict):
 
 
 class PatchAttrs(DascoreBaseModel):
-    """The expected attributes for a Patch."""
+    """
+    The expected attributes for a Patch.
+
+    The default attributes are:
+    ```{python}
+    #| echo: false
+
+    import dascore as dc
+    from IPython.display import Markdown
+
+    df_str = (
+        dc.PatchAttrs.get_summary_df()
+        .reset_index()
+        .to_markdown(index=False, stralign="center")
+    )
+    Markdown(df_str)
+    ```
+    """
 
     model_config = ConfigDict(
         title="Patch Summary",

dascore/core/patch.py

@@ -25,6 +25,8 @@ class Patch:
     """
     A Class for managing data and metadata.
 
+    See the [patch tutorial](/tutorial/patch.qmd) for examples.
+
     Parameters
     ----------
     data

dascore/core/spool.py

@@ -587,9 +587,9 @@ def _load_patch(self, kwargs) -> Self:
 @singledispatch
 def spool(obj: Path | str | BaseSpool | Sequence[PatchType], **kwargs) -> BaseSpool:
     """
-    Create a spool from some data source.
+    Create a spool from a data source.
 
-    This function is used to load data from many different sources.
+    This is the main function for loading in DASCore.
 
     Parameters
     ----------