Skip to content

Commit

Permalink
Add backticks to format file names as code (#7)
Browse files Browse the repository at this point in the history
The Actions summary view is formatted as Markdown, as Python uses `__`
around files (like `__init__.py`) this looks wrong. If we add (escaped)
backticks it looks much nicer.

Based on an idea by @oscargus raised in #4.
  • Loading branch information
nickcharlton authored Aug 16, 2024
1 parent 2805447 commit 3e9a4fa
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion bin/diff-check
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ if ! git diff-index --quiet HEAD; then
printf 'These files changed when running the command:\n\n'

git diff --name-only | while read -r n ; do
echo "* $n"
echo "* \`$n\`"
done

exit 1
Expand Down
2 changes: 1 addition & 1 deletion spec/black_box/diff-check_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
expect(session.run("diff-check")).to have_stdout(<<~SUMMARY
These files changed when running the command:
* README
* `README`
SUMMARY
)
end
Expand Down

0 comments on commit 3e9a4fa

Please sign in to comment.