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

protobuf bytecode spec generates invalid markdown #65

Open
0rphon opened this issue Nov 1, 2022 · 0 comments
Open

protobuf bytecode spec generates invalid markdown #65

0rphon opened this issue Nov 1, 2022 · 0 comments
Labels
Bug Something isn't working. Docs Improvements or additions to documentation. Low A low priority issue.
Milestone
Docs and CI

Comments

@0rphon
Copy link
Contributor

0rphon commented Nov 1, 2022

A bug in protoc-gen-doc makes it so multi-line comments don't get formatted correctly in markdown tables. This pr and this pr already exist to fix this, but neither of them have been merged. Once either one is merged we can re-generate markdown docs and have them actually display correctly, but for now you need to go through and manually fix the markdown after generating it.
@0rphon 0rphon added Bug Something isn't working. Docs Improvements or additions to documentation. Low A low priority issue. labels Nov 1, 2022
@0rphon 0rphon mentioned this issue Nov 1, 2022
Merged
@Slickbird Slickbird added this to the Docs and CI milestone Nov 7, 2022
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. Docs Improvements or additions to documentation. Low A low priority issue.
Projects
None yet
Milestone
Docs and CI
Development

No branches or pull requests
2 participants
@0rphon @Slickbird