Method: Pry::WrappedModule#doc

Defined in:
lib/pry/wrapped_module.rb

#doc ⇒ String

Returns documentation for the module. This documentation is for the primary candidate, if you would like documentation for other candidates use ‘WrappedModule#candidate` to select the candidate you’re interested in.

Returns:

  • (String) —

    The documentation for the module.

Raises:



195
196
197
 
# File 'lib/pry/wrapped_module.rb', line 195

def doc
  @doc ||= primary_candidate.doc
end