Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG] mal-formatted markdownfiles : proto-docs tables #727

Closed
JSHan94 opened this issue Apr 18, 2022 · 1 comment
Closed

[BUG] mal-formatted markdownfiles : proto-docs tables #727

JSHan94 opened this issue Apr 18, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@JSHan94
Copy link

JSHan94 commented Apr 18, 2022 •
edited
Loading

Describe the bug

Some proto-docs tables look broken as a following figure.

image

To Reproduce

This is related with a protoc-gen-doc plugin. You can see an issue in here. It said multi-line comments for RPC did not work correctly.

image

This kind of comments will result in mal-formatted tables.

Suggested Solution

  1. One-line comments
  • Easy way to solve this problem right now
  1. Wait protoc-gen-doc updates
  • This PR will fix the problem
@JSHan94 JSHan94 added the bug Something isn't working label Apr 18, 2022
@JSHan94 JSHan94 changed the title [BUG] Broken proto-docs tables [BUG] mal-formatted markdownfiles : proto-docs tables Apr 18, 2022
@gregnuj gregnuj closed this as completed May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@gregnuj @JSHan94 and others