Skip to content

Commit e13ffda

Browse files
authored
[Docs] Small docs update (#928)
* Small docs update * Pin dask
1 parent 221077f commit e13ffda

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ This repository uses [Poetry](https://python-poetry.org/) to manage dependencies
1717

1818
Alternatively you can run `poetry run mkdocs serve`
1919

20-
!!! tip
21-
You can use the optional `--dirty` flag to only rebuild changed files, although you may need to restart if you make changes to `mkdocs.yaml`.
20+
> [!TIP]
21+
> You can use the optional `--dirty` flag to only rebuild changed files, although you may need to restart if you make changes to `mkdocs.yaml`.
2222
2323
### Building
2424

@@ -38,13 +38,13 @@ You can manually deploy by running the command `mkdocs gh-deploy --force` from t
3838
#### Symlinked Files
3939

4040
Several directories and files are symlinked into the MkDocs' `/docs`[^1] directory in order to be made available to MkDocs. Avoid modifying them directly:
41-
* `/docs/icechunk-python/examples/`
42-
* `/docs/icechunk-python/notebooks/`
43-
* `/docs/spec.md`
41+
- `/docs/icechunk-python/examples/`
42+
- `/docs/icechunk-python/notebooks/`
43+
- `/docs/spec.md`
4444

4545
These are also ignored in `.gitignore`
4646

47-
!!! tip
48-
See [icechunk-docs/macros.py](./macros.py) for more info.
47+
> [!TIP]
48+
> See [icechunk-docs/macros.py](./macros.py) for more info.
4949
5050
[^1]: Disambiguation: `icechunk/docs/docs`

docs/docs/icechunk-python/virtual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ We have a virtual dataset with 31 timestamps! One hint that this worked correctl
8787
```python
8888
import icechunk
8989

90-
storage = icechunk.local_filesystem(
90+
storage = icechunk.local_filesystem_storage(
9191
prefix='oisst',
9292
)
9393

icechunk-python/pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ test = [
3232
"pytest-asyncio",
3333
"pytest-xdist",
3434
"ruff",
35-
"dask>=2024.11.0",
36-
"distributed>=2024.11.0",
35+
"dask>=2024.11.0,<2025.04.0",
36+
"distributed>=2024.11.0,<2025.04.0",
3737
"xarray>=2025.01.2",
3838
"hypothesis",
3939
"pandas-stubs",

0 commit comments

Comments
 (0)