Repository navigation
docs: include Base64 in the filter API reference - #881
Open
tongwentao wants to merge 1 commit into
Open
tongwentao wants to merge 1 commit into
tongwentao wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Base64 codec is implemented and tested, but missing from the API reference. This adds it under Filter codecs, following the existing API-page layout. The class docstring now includes a small encoding/decoding example and describes the operation as encoding rather than compression.
Fixes #587.
Behavior and review notes
The new page makes an existing codec discoverable through the same API navigation as the other filters. The round-trip example demonstrates reversible Base64 encoding of binary data; it does not claim a reduction in size. The implementation, codec configuration, and encoded-byte compatibility are unchanged.
Validation:
python -m pytest tests/test_base64.py src/numcodecs/base64.py -q --no-cov: 9 passed, including the new doctest.maindocumentation build in the same environment: the existingBlosc.decode_partialreference and two references in the Meson migration design document. No new warnings were introduced; a warnings-as-errors build therefore does not pass.Codex was used to prepare this documentation change and run the checks above.
TODO:
ff95ea1(39 successful, 2 publishing checks skipped; checked 2026-10-24).