added example of creating zarr arrays in README
[Description of PR] Updated the README
- added quick example of creating N-dimenional arrays with zarr
- added a link to the list of arrays creation routines
TODO:
- [ ] Add unit tests and/or doctests in docstrings
- [ ] Add docstrings and API docs for any new/modified user-facing classes and functions
- [ ] New/modified features documented in docs/tutorial.rst
- [ ] Changes documented in docs/release.rst
- [ ] GitHub Actions have all passed
- [ ] Test coverage is 100% (Codecov passes)
Hi @baimamboukar. Thanks for the PR. Let's keep all the main feature bullet points together. Your suggestion might fall under a new header like "Quickstart" or similar. Let's see if anyone else has tips for starting points that might should be added.
Codecov Report
Merging #1166 (58e038c) into main (d3a817c) will increase coverage by
0.00%. The diff coverage isn/a.
@@ Coverage Diff @@
## main #1166 +/- ##
=======================================
Coverage 99.95% 99.95%
=======================================
Files 36 36
Lines 14142 14143 +1
=======================================
+ Hits 14135 14136 +1
Misses 7 7
| Impacted Files | Coverage Δ | |
|---|---|---|
| zarr/util.py | 100.00% <0.00%> (ø) |
Curious how this compares to what is in the Tutorial? If there's not something there, maybe we can add to it? Or perhaps the Tutorial could be refactored?
My understanding was that the problem was there was no "umpf" in the README itself and this was to draw users into the tutorial, but I agree, the redundancy isn't great.