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 "," #68

Closed
fulviodenza opened this issue May 19, 2022 · 4 comments
Closed

Bug in generating markdown files with "," #68

fulviodenza opened this issue May 19, 2022 · 4 comments

Comments

@fulviodenza
Copy link

fulviodenza commented May 19, 2022

Hi! I noticed that when I generate markdown files containing the symbol "," it prints out in the md file this: "'backslash'," (I put the 'backslash' string instead of the symbol because it does not prints the symbol here.

Is there something I'm missing or is it a bug?

To test the issue you can simply create a comment (with one or more lines) like the following:
// Lorem ipsum dolor sit amet, hello world

@kylie-sre
Copy link

I am also having this issue with periods as well. It appears that special characters are being escaped in the doc strings as well

@fulviodenza
Copy link
Author

Hi @princjef, ping for this issue

dbarria added a commit to dbarria/gomarkdoc that referenced this issue Jul 4, 2022
…avoid generating markdown with dot and colon characters escaped (princjef#68)
@princjef
Copy link
Owner

princjef commented Jul 7, 2022

Thanks for reporting the issue @fulviodenza and @kylie-sre. #70 looks like a valid fix for the issue so we'll focus on getting that in to resolve this.

Out of curiosity, what tool(s) do you use where the escaping is causing you issues? I work and test primarily in GitHub and Azure DevOps, which both have no problem with the escaped characters

@princjef
Copy link
Owner

princjef commented Jul 7, 2022

fixed by #70

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

3 participants