[v3] add json indentation to config

zarr-developers / zarr-python

An implementation of chunked, compressed, N-dimensional arrays for Python.

http://zarr.readthedocs.io/

MIT License

1.44k stars 272 forks source link

[v3] add json indentation to config #1952

Closed d-v-b closed 2 months ago

d-v-b commented 2 months ago

Level of JSON indentation is set by by the global config object.

resolves #704

TODO:

[x] 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)

d-v-b commented 2 months ago

The correct tests would compare JSON documents with different levels of json_indent values, to ensure that the indentation is working correctly. If we do want those tests, I can add them, but I think I would rather defer that for a big sprint to fill out the metadata tests.

jhamman commented 2 months ago

I like the feature and I'm happy to see this go in. I expect the specific implementation will change a bit with #1851 but that is fine with me.

will-moore commented 2 months ago

Looks great, thanks. Working as expected for me. 👍