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

docs: Fix ineffective escaping, emphasize error messages #1671

Merged
merged 1 commit into from
Jun 21, 2024
Merged

docs: Fix ineffective escaping, emphasize error messages #1671

merged 1 commit into from
Jun 21, 2024

Conversation

bittner
Copy link
Contributor

@bittner bittner commented Jun 21, 2024

As discussed in #1668 (comment):

Screenshot from 2024-06-21 15-42-42

Fixes the broken markup by using HTML entities.

In addition, I used slanted font (emphasized) for the error messages to make it clearer how to interpret the text.

Copy link
Member

@sisp sisp left a comment

Choose a reason for hiding this comment

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

Prettier is unhappy again:

       > index ce26b42..ec9dec4 100644
       > --- a/docs/updating.md
       > +++ b/docs/updating.md
       > @@ -216,9 +216,9 @@ the introduced changes to your code base, specifically when you have unpleasant
       >  conflicts, it's not 100% obvious how to get back to the previously clean copy of your
       >  branch. The following strategies won't work:
       >  
       > --   `git checkout <branch>` – *error: you need to resolve your current index first*
       > --   `git checkout .` – *error: path '&lt;filename&gt;' is unmerged*
       > --   `git merge --abort` – *fatal: There is no merge to abort (MERGE_HEAD missing)*
       > +-   `git checkout <branch>` – _error: you need to resolve your current index first_
       > +-   `git checkout .` – _error: path '&lt;filename&gt;' is unmerged_
       > +-   `git merge --abort` – _fatal: There is no merge to abort (MERGE_HEAD missing)_
       >  
       >  Here is what you can do using Git in the terminal to throw away all changes:

Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.38%. Comparing base (b581d8d) to head (8901287).
Report is 70 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1671      +/-   ##
==========================================
+ Coverage   97.32%   97.38%   +0.05%     
==========================================
  Files          49       49              
  Lines        5004     5004              
==========================================
+ Hits         4870     4873       +3     
+ Misses        134      131       -3     
Flag Coverage Δ
unittests 97.38% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@sisp sisp left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@sisp sisp merged commit b8ad16d into copier-org:master Jun 21, 2024
21 checks passed
@bittner bittner deleted the fix/docs-backslash-vs-html-entities branch June 21, 2024 17:44
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.

3 participants