Update doc comments guidelines #3037
Merged
Conversation
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
pquentin
pushed a commit
that referenced
this pull request
Jan 2, 2025
(cherry picked from commit ddf9cd9)
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
pquentin
added a commit
that referenced
this pull request
Jan 2, 2025
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.
Update doc comments guidelines to ensure the best looking output in OpenAPI as well as in all other places which are using Markdown rendering.
The blank line creates a proper paragraph in all places other than the OpenAPI output - e.g. the in-code documentation of the generated clients. Without this, the text looks very squashed.