Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct example endianness reference #320

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Conversation

thewtex
Copy link
Contributor

@thewtex thewtex commented Dec 6, 2024

The examples references a "configuration below" as little endian, but the configuration contains:

        "codecs": [{
            "name": "bytes",
            "configuration": {
                "endian": "big"
            }
        }],

I assume that this is the right fix. If not, it would be helpful to extend the documentation to provide a more detailed explanation.

In general, it would be helpful to document how endianness works with Zarr 3.

I currently see just the note:

We are explicitly looking for more feedback and prototypes of code using the r*, raw bits, for various endianness and whether the spec could be made clearer.

And the Data Types page is empty.

@jbms @normanrz @joshmoore @MSanKeys963

@normanrz
Copy link
Member

normanrz commented Dec 6, 2024

Thanks for pointing this out. We could also change the example to "endian": "little", no?

@thewtex
Copy link
Contributor Author

thewtex commented Dec 6, 2024

We could also change the example to "endian": "little", no?

Yes, that would work, too. Is that preferred?

@normanrz
Copy link
Member

normanrz commented Dec 6, 2024

I think I would use little endian in the example because it is much more common these days. No strong opinion here, though.

The examples references a "configuration below" as little endian, but the configuration contains:

```json
        "codecs": [{
            "name": "bytes",
            "configuration": {
                "endian": "big"
            }
        }],
```
@thewtex
Copy link
Contributor Author

thewtex commented Dec 6, 2024

I think I would use little endian in the example because it is much more common these days. No strong opinion here, though.

👍 flipped to little endian.

@joshmoore
Copy link
Member

Re-launched the RTD build. If it keeps failing, then something has likely broken upstream.

@joshmoore
Copy link
Member

Unrelated to this PR:

  File "/home/docs/checkouts/readthedocs.org/user_builds/zarr-specs/envs/320/lib/python3.11/site-packages/packaging/version.py", line 202, in __init__
    raise InvalidVersion(f"Invalid version: {version!r}")
packaging.version.InvalidVersion: Invalid version: ''

@jbms jbms merged commit 3e8fc19 into zarr-developers:main Jan 8, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants