search

princjef / gomarkdoc

Generate markdown documentation for Go (golang) code
MIT License
380 stars 60 forks source link

Bug in generating markdown files with "," #68

Closed fulviodenza closed 2 years ago

fulviodenza commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

Hi @princjef, ping for this issue

princjef commented 2 years ago

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 commented 2 years ago

fixed by #70