Skip to content

Document the public API - #12

Merged
samuel-williams-shopify merged 1 commit into
mainfrom
document-public-api
Sep 7, 2026
Merged

Document the public API#12
samuel-williams-shopify merged 1 commit into
mainfrom
document-public-api

Conversation

@samuel-williams-shopify

@samuel-williams-shopify samuel-williams-shopify commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document all previously undocumented public classes, modules, and methods
  • add typed parameter, return value, yielded block, and exception pragmas following the Decode Ruby documentation guidelines
  • mark the XRB and generated fallback parser modules as namespaces

Verification

  • bundle exec bake decode:index:coverage lib — 121/121 public definitions documented
  • bundle exec bake test — 133 tests, 153 assertions
  • XRB_PREFER_FALLBACK=1 bundle exec bake test — 133 tests, 153 assertions
  • bundle exec rubocop — 50 files, no offenses
  • bundle exec bake xrb:parsers:generate_fallback — generated parser remains reproducible
  • git diff --check

Assisted-By: devx/7ef83274-928f-499d-b668-48449b1ff60e
@samuel-williams-shopify
samuel-williams-shopify merged commit 4e85424 into main Sep 7, 2026
52 of 56 checks passed
@samuel-williams-shopify
samuel-williams-shopify deleted the document-public-api branch September 7, 2026 08:29
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