Exception: ReadmeYard::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/readme_yard/error.rb

Class Method Summary collapse

Class Method Details

.object_not_found(object_path, tag_name) ⇒ Object

TODO:

Look for instance method with same name if class method and vise versa to give a more helpful error. Look for the object path in other scopes.



10
11
12
13
14
 
# File 'lib/readme_yard/error.rb', line 10

def object_not_found(object_path, tag_name)
  new("*Readme Yard* could not find `#{object_path}`. Perhaps" \
      " the `@#{tag_name}` tag was moved, mispelled," \
      " or the `.yardopts` YARD file is missing the file path.")
end