Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc improvements #335

Merged
merged 5 commits into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion dascore/core/attrs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 2 additions & 0 deletions dascore/core/patch.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ class Patch:
"""
A Class for managing data and metadata.

See the [patch tutorial](/tutorial/patch.qmd) for examples.

Parameters
----------
data
Expand Down
4 changes: 2 additions & 2 deletions dascore/core/spool.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down
Loading