search

pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.63k stars 464 forks source link

Fix Scalar Value Types Table for Markdown #454

Closed Akronymus-git closed 1 year ago

Akronymus-git commented 3 years ago

As per the markdown guidelines you need at least three dashes to have a properly formatted table. As the Go and C# example didn't have it, it caused the table to not render in Rider and Visual Studio. I suspect it will not render in others either.

Fixes #453

Akronymus-git commented 3 years ago

@pseudomuto As per the Contributing.md, I am adding the the ping.

pseudomuto commented 3 years ago

Hey @ChristophGra, thanks for the PR! Can you please run make examples and add an entry to CHANGELOG.md under the unreleased heading?

Akronymus-git commented 3 years ago

I must admit that I haven't worked with go before, so I'd appreciate it if you could point me to where I find the documentation on how to do that. I tried using go run but it gave me the error that it is not a main package. Furthermore, when I tried to run it via protoc, even though I ran go install on the package, I didn't manage to get it to use the new version.

@pseudomuto thanks for your time in advance.

Akronymus-git commented 3 years ago

Ok, @pseudomuto I got it to locally generate from the new template by passing it as a doc_opt and it has generated correct markdown, which rendered properly in VSCode, as well as Rider and Visual Studio. Additionally I pushed a change to add the entry to the changelog.

tmc commented 2 years ago

@ChristophGra can you rebase this?

Akronymus-git commented 2 years ago

@tmc like that? I hope I did the rebase right.

pseudomuto commented 2 years ago

@ChristophGra this looks 👌 Can you run make examples or make docker_test to ensure that the generated files are updated (I get a diff when I run it on this branch).

Once that's done we can get this merged....FINALLY 😬

pseudomuto commented 2 years ago

The Makefile has changed a bit. Running either make build/examples or make test/docker after a rebase should get the example files sorted out.