Skip to content

Add description to type/complex/array schema#170

Merged
gnidan merged 1 commit intomainfrom
writer-array-description
Mar 9, 2026
Merged

Add description to type/complex/array schema#170
gnidan merged 1 commit intomainfrom
writer-array-description

Conversation

@gnidan
Copy link
Member

@gnidan gnidan commented Mar 9, 2026

Summary

  • Added top-level description to type/complex/array.schema.yaml, which was the only schema missing one entirely
  • Added property description for contains field
  • Added # example: comments to all three examples (dynamically-sized, fixed-size, nested)

Test plan

  • Verify schema still validates correctly (yarn test)
  • Check rendered description in schema viewer

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.
Copy link
Member Author

@gnidan gnidan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-09 14:05 UTC

@gnidan gnidan merged commit 9f17af1 into main Mar 9, 2026
4 checks passed
@gnidan gnidan deleted the writer-array-description branch March 9, 2026 14:01
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.

1 participant