Skip to content

Commit cf30867

Browse files
authored
Merge pull request #16 from thewtex/patch-1
Update README.md examples to use xarray_dataclass
2 parents db1acc0 + f169873 commit cf30867

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ xarray-dataclass is a Python package that makes it easy to create [xarray]'s Dat
1919
```python
2020
from dataclasses import dataclass
2121
from typing import Literal
22-
from xarray_dataclasses import AsDataArray, Coord, Data
22+
from xarray_dataclass import AsDataArray, Coord, Data
2323

2424

2525
X = Literal["x"]
@@ -66,8 +66,8 @@ Note that the following code is supposed in the examples below.
6666
```python
6767
from dataclasses import dataclass
6868
from typing import Literal
69-
from xarray_dataclasses import AsDataArray, AsDataset
70-
from xarray_dataclasses import Attr, Coord, Data, Name
69+
from xarray_dataclass import AsDataArray, AsDataset
70+
from xarray_dataclass import Attr, Coord, Data, Name
7171

7272

7373
X = Literal["x"]
@@ -203,13 +203,13 @@ Attributes:
203203

204204
### Coordof and Dataof type hints
205205

206-
xarray-dataclasses provides advanced type hints, `Coordof` and `Dataof`.
206+
xarray-dataclass provides advanced type hints, `Coordof` and `Dataof`.
207207
Unlike `Data` and `Coord`, they specify a dataclass that defines a DataArray class.
208208
This is useful when users want to add metadata to dimensions for [plotting].
209209
For example:
210210

211211
```python
212-
from xarray_dataclasses import Coordof
212+
from xarray_dataclass import Coordof
213213

214214

215215
@dataclass
@@ -294,7 +294,7 @@ A custom factory for DataArray or Dataset creation is only supported in the curr
294294

295295
```python
296296
import xarray as xr
297-
from xarray_dataclasses import DataOptions
297+
from xarray_dataclass import DataOptions
298298

299299

300300
class Custom(xr.DataArray):
@@ -330,7 +330,7 @@ This is useful when users do not want to inherit the mix-in class (`AsDataArray`
330330
For example:
331331

332332
```python
333-
from xarray_dataclasses import asdataarray
333+
from xarray_dataclass import asdataarray
334334

335335

336336
@dataclass

0 commit comments

Comments
 (0)