Fix proto comments for better markdown output #1331
Merged
Conversation
This file contains 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
hsorellana
requested review from
aLekSer,
calebatwd,
HazWard,
syntxerror,
Laremere and
sawagh
as code owners
HazWard
reviewed
Jan 11, 2021
Laremere
reviewed
Jan 14, 2021
| @@ -239,9 +236,10 @@ message Match { | |||
| reserved 5, 6; | |||
| } | |||
|
|
|||
| // Represents a backfill entity which is used to fill partially full matches. | |||
| // | |||
There was a problem hiding this comment.
You removed this newline between the comment and the beta feature warning elsewhere, why add it here?
There was a problem hiding this comment.
My initial intention was to keep a separate line between object description and the beta feature warning but i realized this only works at top level. If i put a separate line in an inner field, the markdown generated has tables broken visually
Laremere
approved these changes
Jan 15, 2021
Merged
syntxerror
added
area/developer-experience
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / Why we need it:
Improves the definition in protobuf objects so when the autogenerated documentation has an improved display of it
Which issue(s) this PR fixes:
Special notes for your reviewer: