Skip to content

Commit e946834

Browse files
committed
Added/updated comments
1 parent 97acc59 commit e946834

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
<p align="center">
44
<img src="./development/images/icon/images/icon.png" width="150" alt="Todo PR Checker">
55
</p>
6-
<!-- The app will only report on TODO items in code comments -->
6+
<!-- TODO: The app will only report on TODO items in code comments, each line is only counted once. -->
77
Do you keep forgetting to resolve that one `// TODO:...` or fix the last ` # Bug...` before merging your Pull Requests?
88
<!--
99
The capitalization of the todo, FixMe or BUG does not matter.
10-
Neither does it, where in the comment the TODO is located.
10+
If action items are located close to each other, the embedded code link will contain a range of lines,
11+
as is happening here. It also does not matter where in the comment the TODO is located.
1112
-->
1213

1314
The Todo PR Checker will make sure that doesn't happen anymore.

app.rb

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@
2323
configure :development do
2424
set :logging, Logger::DEBUG
2525
end
26-
26+
=begin Not a BUG: Don't worry about words that contain action items
27+
lines like this one will be ignored - it's really BUGGING me when action items are misreported!
28+
The line above is only shown in the app's comment because the lines above and below contain a TODO
29+
=end
2730
puts "Running Todo PR Checker version: #{VERSION}"
2831

2932
before '/' do

0 commit comments

Comments
 (0)