Skip to content

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

@JSHan94

Description

@JSHan94

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions