Class Pry::Command::ShowDoc
In: lib/pry/commands/show_doc.rb
Parent: Command::ShowInfo

Methods

Included Modules

Pry::Helpers::DocumentationHelpers

Public Instance methods

The docs for code_object prepared for display.

Return docs for the code_object, adjusting for whether the code_object has yard docs available, in which case it returns those. (note we only have to check yard docs for modules since they can have multiple docs, but methods can only be doc‘d once so we dont need to check them)

Which sections to include in the ‘header’, can toggle: :owner, :signature and visibility.

process the markup (if necessary) and apply colors

figure out start line of docs by back-calculating based on number of lines in the comment and the start line of the code_object @return [Fixnum] start line of docs

[Validate]