DOC: minor errors/typos in tutorials

Open
#351 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
jupyter-notebook
Domain
documentation

Research direction

Update overview/xarray-in-45-min.ipynb near line 68 and intermediate/intro-to-zarr.ipynb near line 412. Check the surrounding tutorial text, correct the dataset function name and shard chunk count as described, then review both notebook passages to confirm the wording and arithmetic are accurate.

Written by the indexing model from the issue text.

Description

  1. Note that behind the scenes the tutorial.open_dataset downloads a file

https://github.com/xarray-contrib/xarray-tutorial/blob/93d41e286700782e913f3c20301d2e248338911f/overview/xarray-in-45-min.ipynb#L68

should probably say "Note that behind the scenes the tutorial.load_dataset downloads a file.

  1. ... Zarr array with a chunk size of (100, 100, 100) and a shard size of (1000, 1000, 1000). This means that each shard will contain 10 chunks ...

https://github.com/xarray-contrib/xarray-tutorial/blob/93d41e286700782e913f3c20301d2e248338911f/intermediate/intro-to-zarr.ipynb#L412

should probably say "each shard will contain 1000 chunks"

Dominant language
Jupyter Notebook
Stars
204
Forks
121
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/xarray-tutorial

All issues in xarray-contrib/xarray-tutorial

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.