chore: preview YARD formatting fixes from gapic-generator-ruby #1337 - #36487
Closed
suztomo wants to merge 1 commit into
Closed
chore: preview YARD formatting fixes from gapic-generator-ruby #1337#36487suztomo wants to merge 1 commit into
suztomo wants to merge 1 commit into
Conversation
Member
Author
|
Closing draft preview PR as changes are tracked in googleapis/gapic-generator-ruby#1337. |
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
This draft PR previews code regeneration across libraries generated with the fixes in googleapis/gapic-generator-ruby#1337.
Changes
(?<!\\)\{(?=[^\s])->\\{) outside backtick spans in proto docstrings, preventing multiline JSON examples and ranges (e.g.{min: ...\n...}or{100, 200, ...}) from being misparsed by YARD as broken object links.(?<=\A|\s)@tagoutside backtick spans ->`@tag`) so tags like@patternand@requiredin proto comments are rendered as literal text rather than unrecognized YARD tags.Verification
librarian generate --allwith locally installedgapic-generatorgem.toys ci --yard --gems google-cloud-compute-v1passes with 0 warnings and 0 errors.toys ci --test --rubocop --doctest --gems google-cloud-compute-v1passes with 0 errors/failures.Related: