docs: remove phantom multi-context proof API - #18
Merged
peetzweg merged 1 commit intoJun 23, 2026
Conversation
The READMEs documented `create_multi_context`, `validate_multi_context`, `is_valid_multi_context`, and `MultiContextResult` as public API, but none of these are implemented in lib.rs — only a test named `test_multi_context_aliases_are_unlinkable` exists (it exercises `alias_in_context`). Documenting a non-existent API misleads consumers. Removes the TOC entry, concept section, full API-reference section, the orphaned "Encoding Contexts" helper, the @polkadot/types contexts example (repurposed to members), and the `MultiContextResult` type. Also drops the three phantom rows from the package README's API table.
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.
Removes documentation for a multi-context proof API that does not exist in the bindings.
Both READMEs documented
create_multi_context,validate_multi_context,is_valid_multi_context, and theMultiContextResulttype as public API. None of these are implemented inpackages/verifiablejs/src/lib.rs— the only "multi context" thing in the codebase is a test namedtest_multi_context_aliases_are_unlinkable, which actually just exercisesalias_in_context. A consumer following the docs would hitundefined is not a function.Removed
MultiContextResultinterface.@polkadot/typesexample only demonstrated encodingVec<Vec<u8>>contexts (multi-context input) — repurposed it to encoding members, which is a real need.create_multi_contextmention in thealias_in_contextdescription.Notes
mainonce feat: add encode_members helper + fix README accuracy (#2, #3) #17 merges, or merge feat: add encode_members helper + fix README accuracy (#2, #3) #17 first.