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

fix(format): remove dot and colon characters from escape function #70

Merged
merged 3 commits into from
Jul 7, 2022

Conversation

dbarria
Copy link
Contributor

@dbarria dbarria commented Jul 4, 2022

When a paragraph contains the dot or colon characters, the generated markdown escapes those characters breaking the markdown visualization in other tools than Github.

This commit removes those characters from the escape function and apparently doesn't affect the other escape logic.

…avoid generating markdown with dot and colon characters escaped (princjef#68)
@dmvolod
Copy link
Contributor

dmvolod commented Jul 4, 2022

@dbarria it looks like the effect of an issue #68 and should be fixed before

@dbarria
Copy link
Contributor Author

dbarria commented Jul 5, 2022

@dbarria it looks like the effect of an issue #68 and should be fixed before

@dmvolod Could you elaborate, please? Where do you think it should be fixed?

@fulviodenza
Copy link

@dbarria it looks like the effect of an issue #68 and should be fixed before

This should be the PR that fixes the issue I opened, isn't it?

fulviodenza
fulviodenza previously approved these changes Jul 5, 2022
@dmvolod
Copy link
Contributor

dmvolod commented Jul 5, 2022

Oh, sorry @dbarria my bad, you've fixed the core of the #68, missed this.

princjef
princjef previously approved these changes Jul 7, 2022
Copy link
Owner

@princjef princjef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the change and updating the tests!

@princjef
Copy link
Owner

princjef commented Jul 7, 2022

@dbarria thanks for the PR! Out of curiosity, what tool(s) do you work with that have trouble with the backslash escaping?

@princjef princjef dismissed stale reviews from fulviodenza and themself via 91c9bb4 July 7, 2022 06:56
@codecov-commenter
Copy link

Codecov Report

Merging #70 (91c9bb4) into master (2efd0c5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #70   +/-   ##
=======================================
  Coverage   67.82%   67.82%           
=======================================
  Files          17       17           
  Lines        1557     1557           
=======================================
  Hits         1056     1056           
  Misses        415      415           
  Partials       86       86           
Impacted Files Coverage Δ
format/formatcore/base.go 44.54% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2efd0c5...91c9bb4. Read the comment docs.

@princjef princjef changed the title fix(format): remove dot and colon characters from escape function (#68) fix(format): remove dot and colon characters from escape function Jul 7, 2022
@princjef princjef merged commit 4118600 into princjef:master Jul 7, 2022
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

Successfully merging this pull request may close these issues.

5 participants