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.

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

Bug in generating markdown files with characters *(){}[]- #77

Closed
manlopes opened this issue Jul 19, 2022 · 1 comment
Closed

Bug in generating markdown files with characters *(){}[]- #77

manlopes opened this issue Jul 19, 2022 · 1 comment

Comments

@manlopes
Copy link

manlopes commented Jul 19, 2022

Hi, I've noticed that, when generating markdown files with some characters like "*(){}[]-", the output is not correct and backslashes are added to the md file before each of the characters. See example below:

Source comment:

// **param** c (context.Context): Execution context

markdown output

\*\*param\*\* ctx \(context.Context\): Execution context

This issue is similar to issue #68

@manlopes manlopes changed the title Bug in generating markdown files with characters *() Bug in generating markdown files with characters *(){}[]- Jul 19, 2022
@princjef
Copy link
Owner

Hi @manlopes, this tool is intentionally aligned with the golang documentation syntax for doc comments, not markdown. This is to maintain consistency with the pkg.go.dev experience and avoid generating documentation that only renders correctly in one place or the other. As a result, markdown-specific syntax like ** for bold items is intentionally escaped as we don't want things being implicitly interpreted as markdown.

If there are other specific rendering bugs that you've found, please feel free to reactivate this issue. I hope that description helped.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants