Repository navigation
Add description to type/complex/array schema - #170
Merged
Merged
Conversation
The array complex type schema was missing a top-level description. Added schema description, property description for `contains`, and example comments for all three examples.
gnidan
commented
Mar 9, 2026
gnidan
left a comment
gnidan
left a comment
Member
Author
There was a problem hiding this comment.
Schema architect review: Looks good
The description is accurate — arrays have a wrapper contains and optional count for fixed-size vs dynamic. The contains field description correctly references ethdebug/format/type/wrapper using the same bold convention seen elsewhere. Example comments are clear and helpful.
Minor note: most sibling complex type schemas (struct, mapping, tuple, alias) use terse one-liner descriptions like "Schema for representing mapping types", while this is multi-line. That's fine — the function schema also uses multi-line — but worth noting for future consistency decisions.
LGTM.
Contributor
|
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
1 participant
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.
Summary
type/complex/array.schema.yaml, which was the only schema missing one entirelycontainsfield# example:comments to all three examples (dynamically-sized, fixed-size, nested)Test plan
yarn test)