fix(gapic-generator): Indent note in the Config#credentials attribute properly - #1319
Open
dazuma wants to merge 2 commits into
Open
fix(gapic-generator): Indent note in the Config#credentials attribute properly#1319dazuma wants to merge 2 commits into
dazuma wants to merge 2 commits into
Conversation
Contributor
|
/gcbrun Thanks @dazuma, we appreciate the contribution! We will likely hold-off until next week at least, since we have a couple changes in-flight. Adding do not merge for now! |
aandreassa
added
the
do not merge
Contributor
Author
@aandreassa No worries. This would trigger a regen of every gapic, so y'all would want to manage it carefully. |
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
2 participants
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.
Fixes the indentation on a multi-line
@noteyard tag. Without proper indentation, only the first line gets included in the note, while the remaining lines are orphaned into the general description of the method. (For an example of what this looks like, see https://rubydoc.info/gems/google-cloud-secret_manager-v1/Google/Cloud/SecretManager/V1/SecretManagerService/Client/Configuration#credentials-instance_method — the second warning note on the credentials method is cut off mid-sentence, and the remainder of the note appears below just above the examples.)I found this as I was using secret_manager-v1 as a test case in a YARD plugin I'm working on.
Hope y'all are doing well!