Skip to content

feat: Add generated YARD docs and deprecation metadata to Ruby SDK codegen - #535

Merged
razor-x merged 2 commits into
mainfrom
codex/add-docstring-support-for-codegen
Jul 29, 2026
Merged

feat: Add generated YARD docs and deprecation metadata to Ruby SDK codegen#535
razor-x merged 2 commits into
mainfrom
codex/add-docstring-support-for-codegen

Conversation

@razor-x

@razor-x razor-x commented Jul 28, 2026

Copy link
Copy Markdown
Member

Motivation

  • Improve the generated Ruby SDK by emitting YARD-style documentation, parameter/return descriptions, and deprecation notes for resources and client methods so the SDK is more discoverable and self-documenting.
  • Surface resource- and endpoint-level descriptions from the blueprint into the templates so generated code includes meaningful comments and per-attribute docs.

Description

  • Added Handlebars helpers in codegen/lib/handlebars-helpers.ts (rubyDoc, rubyParamDoc, rubyReturnDoc, rubyDeprecatedDoc) to format Ruby comments and deprecation lines.
  • Updated Handlebars layouts (codegen/layouts/partials/client-method.hbs, codegen/layouts/resource.hbs) to emit documentation blocks, parameter docs, return docs, and deprecation notices where applicable.
  • Extended layout/context builders to carry documentation metadata: codegen/lib/layouts/client.ts, codegen/lib/layouts/resource.ts, codegen/lib/routes.ts, and codegen/lib/ruby-client.ts now include description, isDeprecated, deprecationMessage, parameter descriptions, and responseDescription fields.
  • Plumbed resource documentation through getResources so templates receive resource-level descriptions and property-level metadata.
  • Regenerated Ruby SDK files (many lib/seam/resources/*.rb and lib/seam/routes/*.rb) to include per-attribute comments, split date_accessor entries into individual lines with comments, YARD @param/@return comments on client methods, and @deprecated annotations where relevant.

Testing

  • No automated tests were executed as part of this change.

Codex Task

@razor-x razor-x changed the title Add generated YARD docs and deprecation metadata to Ruby SDK codegen feat: Add generated YARD docs and deprecation metadata to Ruby SDK codegen Jul 29, 2026
@razor-x
razor-x merged commit d83a809 into main Jul 29, 2026
17 checks passed
@razor-x
razor-x deleted the codex/add-docstring-support-for-codegen branch July 29, 2026 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant