Skip to content

chore: preview YARD formatting fixes from gapic-generator-ruby #1337 - #36512

Closed
suztomo wants to merge 1 commit into
googleapis:mainfrom
suztomo:chore/preview-yard-formatting-fixes
Closed

chore: preview YARD formatting fixes from gapic-generator-ruby #1337#36512
suztomo wants to merge 1 commit into
googleapis:mainfrom
suztomo:chore/preview-yard-formatting-fixes

Conversation

@suztomo

@suztomo suztomo commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

This draft PR previews code regeneration across libraries generated with the updated fixes in googleapis/gapic-generator-ruby#1337 (including excluding fenced code blocks and multiline inline code spans from brace escaping and doc tag sanitization, and adding attr, attr_reader, attr_writer).

Changes

  • Escapes multi-line braces ((?<!\\)\{(?=[^\s]) -> \\{) outside backtick spans and fenced code blocks in proto docstrings.
  • Preserves multiline inline code spans (`...`) and fenced code blocks (... and ~~~...~~~) without brace escaping or tag sanitization so code examples (like "divider": {}, @FooBot, and multiline resource name templates) are preserved verbatim.
  • Sanitizes unknown doc tags ((?<=\A|\s)@tag outside backtick spans -> `@tag`) while preserving valid YARD tags (@attr, @attr_reader, @attr_writer, @overload, @param, etc.).

Verification

  • Ran librarian generate --all with locally installed gapic-generator gem (0.51.1).
  • Verified toys ci --yard --gems google-apps-chat-v1 passes with 0 warnings and 0 errors.
  • Verified toys ci --yard --gems google-cloud-compute-v1 passes with 0 warnings and 0 errors.
  • Verified toys ci --yard --gems google-cloud-ai_platform-v1 passes with 0 warnings and 0 errors.

Related:

@suztomo

suztomo commented Sep 1, 2026

Copy link
Copy Markdown
Member Author

All checks passed.

# Required. The resource name of the EntityType for the entities being
# written. Value format:
# `projects/{project}/locations/{location}/featurestores/
# `projects/\\{project}/locations/\\{location}/featurestores/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this needed?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Working on this.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed.

@suztomo suztomo reopened this Sep 2, 2026
@suztomo
suztomo force-pushed the chore/preview-yard-formatting-fixes branch from c7239fe to 38f5e3a Compare September 2, 2026 16:10
@suztomo

suztomo commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

All checks have passed.

@suztomo suztomo closed this Sep 2, 2026
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.

2 participants