lib/overcommit/hook/commit_msg/spell_check.rb in overcommit-0.25.0 vs lib/overcommit/hook/commit_msg/spell_check.rb in overcommit-0.26.0
- old
+ new
@@ -1,8 +1,10 @@
require 'tempfile'
module Overcommit::Hook::CommitMsg
- # Checks the commit message for potential misspellings
+ # Checks the commit message for potential misspellings with `hunspell`.
+ #
+ # @see http://hunspell.sourceforge.net/
class SpellCheck < Base
Misspelling = Struct.new(:word, :suggestions)
MISSPELLING_REGEX = /^[&#]\s(?<word>\w+)(?:.+?:\s(?<suggestions>.*))?/