Skip to content

Commit 5d45737

Browse files
committed
update docs
1 parent 205b027 commit 5d45737

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ dev = [
1414
"scikit-learn>=1.6.1",
1515
"tmm>=0.2.0",
1616
"towncrier>=24.0.0",
17-
"ty>=0.0.1a11"
17+
"ty>=0.0.20"
1818
]
1919
docs = [
2020
"altair>=5.5.0",

src/sax/interpolation.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,10 @@ def to_df(
116116
obj: an xarray or a sax.SType object.
117117
target_name: the name of the target column
118118
in the dataframe (ignored when obj is an SType).
119-
kwargs: the coordinates of the SType values axes
120-
(ignored when obj is an xarray).
119+
kwargs: the coordinates of the SType values axes. You probably want to supply
120+
'wl' or 'f' here, i.e. the coordinates you supplied to generate the SType.
121+
The kwargs are ignored when the object is an xarray as the coordinates are
122+
already embedded in the xarray in that case.
121123
"""
122124
if isinstance(obj, xr.DataArray):
123125
xarr = obj

0 commit comments

Comments
 (0)