docs: fix multiline comments from proto files breaking tables #1431
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
Signed-off-by: Cléo Rebert <cleo.rebert-ext@numspot.com>
|
|
constantoine
changed the title
zepatrik
reviewed
Sep 22, 2023
| @@ -0,0 +1,107 @@ | |||
| <!-- This file is automatically generated. DO NOT EDIT! --> | |||
| <!-- Needed because of https://github.com/pseudomuto/protoc-gen-doc/issues/274 --> | |||
There was a problem hiding this comment.
I added a reference to the issue, because then our github action will notify us when it is fixed upstream 😉
zepatrik
changed the title
7 tasks
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.
FIX: This patch changes how documentation generated from proto files is rendered to fix multiline comments breaking tables.
Related issue(s)
ory/docs#1537
Checklist
introduces a new feature.
contributing code guidelines.
vulnerability. If this pull request addresses a security vulnerability, I
confirm that I got the approval (please contact
security@ory.sh) from the maintainers to push
the changes.
works.
Further Comments
The project
github.com/pseudomuto/protoc-gen-docseems to be unmaintained, so the fix for this bug never made it to upstream.