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

Metadata Query docs/proto-docs section not formatting correctly #376

Closed
2 of 4 tasks
dwedul-figure opened this issue Jul 12, 2021 · 0 comments · Fixed by #2169
Closed
2 of 4 tasks

Metadata Query docs/proto-docs section not formatting correctly #376

dwedul-figure opened this issue Jul 12, 2021 · 0 comments · Fixed by #2169
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone
backlog

Comments

@dwedul-figure
Copy link
Contributor

dwedul-figure commented Jul 12, 2021 •
edited
Loading

Summary of Bug

The Metadata v1 Query section of docs/proto-docs.md is not being generated correctly.

The queries have several lines of comments and it looks like the auto-gen stuff isn't handling it correctly.

The protocgen.sh script is responsible for automatically generating that file whenever make proto-gen is run (along with the go files).

Version

1.5.0

Steps to Reproduce

Navigate your browser to https://github.com/provenance-io/provenance/blob/main/docs/proto-docs.md#provenance.metadata.v1.Query and note that formatting is correct for 1 line, but breaks on the 2nd until the end of that section.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@dwedul-figure dwedul-figure added bug Something isn't working documentation Improvements or additions to documentation labels Jul 12, 2021
@iramiller iramiller added this to the backlog milestone Aug 17, 2021
@SpicyLemon SpicyLemon mentioned this issue Oct 4, 2024
Merged
8 tasks
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 documentation Improvements or additions to documentation
Projects
Provenance Core Protocol Team
Status: Done
Milestone
backlog
Development

Successfully merging a pull request may close this issue.

Fix proto to markdown generation. provenance-io/provenance
2 participants
@iramiller @dwedul-figure