Exception: Kotoshu::SpellcheckError

Inherits:

Error

• Object
• StandardError
• Error
• Kotoshu::SpellcheckError

Defined in:

lib/kotoshu/core/exceptions.rb

Overview

Error raised during spell checking operations.

Examples:

Spell check failure

raise SpellcheckError, "Failed to check word: encoding error"

Instance Attribute Summary

• #word ⇒ String^? readonly

  The word being checked.

Instance Method Summary

• #initialize(message, word: nil) ⇒ SpellcheckError constructor

  Create a new spellcheck error.

Constructor Details

#initialize(message, word: nil) ⇒ SpellcheckError

Create a new spellcheck error.

Parameters:

• message (String) —

  The error message

• word (String) (defaults to: nil) —

  The word being checked (optional)

# File 'lib/kotoshu/core/exceptions.rb', line 77

def initialize(message, word: nil)
  @word = word
  super(message)
end

Instance Attribute Details

#word ⇒ String^? (readonly)

Returns The word being checked.

Returns:

• (String, nil) —

  The word being checked

# File 'lib/kotoshu/core/exceptions.rb', line 83

def word
  @word
end