#79 (all)
Ruby (change)
63 seconds
6 months ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Proper documentation present
B
Pry::Helpers::BaseHelpers#safe_send N
B
Pry::Slop::Option#initialize N
B
Pry::Slop#to_hash N
B
Pry::InputCompleter#select_message N
B
Pry::WrappedModule#method_missing N
B
Pry::Method#method_missing N
B
Pry::Code#method_missing N
B
Pry::Slop#initialize Ne
B
Pry::Code#select Ne
B
Pry::Code#reject Ne
B
Pry::Forwardable#def_private_delegators Ne
B
Pry::CLI.add_option_processor Ne
B
Pry::Slop::Commands#each Ne
B
Pry::CLI.add_options Ne
B
Pry#raise_up_common Ne
B
Pry::Slop#each Ne
B
Pry::ClassCommand#subcommands Ne
B
Pry::REPLFileLoader#non_interactive_mode Ne
B
Pry::Slop#separator Ne
B
Pry::Command#command_block= Ne
B
Pry::Helpers::DocumentationHelpers.strip_comments_from_c_code Ne
B
Pry::Command::Edit::FileAndLineLocator.from_filename_argument Ne
B
Pry::Helpers::DocumentationHelpers.strip_leading_whitespace Ne
B
Pry::Command::ShowSource#render_doc_markup_for Ne
B
Pry::Helpers::CommandHelpers#one_index_range Ne
B
Pry::Method.singleton_class_resolution_order Ne
B
Pry::Helpers::OptionsHelpers.method_options Ne
B
Pry::Command::ShowDoc#render_doc_markup_for Ne
B
Pry::Editor#build_editor_invocation_string Ne
B
Pry::Command::CodeCollector.inject_options Ne
B
Pry::Method::WeirdMethodLocator#initialize Ne
B
Pry::Helpers::BaseHelpers#stagger_output Ne
B
Pry::Command#check_for_command_collision Ne
B
Pry::Command::ShowInfo#file_and_line_for Ne
B
Pry::Method::Disowned#method_missing Ne
B
Pry::Command::ShowSource#content_for Ne
B
Pry::Method::Patcher#patch_in_ram Ne
B
Pry::Command::CodeCollector#file= Ne
B
Pry::Command::ShowSource#docs_for Ne
B
Pry::Command::ShowDoc#content_for Ne
B
Pry::Helpers::BaseHelpers#heading Ne
B
Pry::Method::Patcher#initialize Ne
B
Pry::Command::ShowDoc#docs_for Ne
B
Pry::InputCompleter#build_path Ne
B
Pry::Command::ShowInfo#header Ne
B
Pry::Command.command_options Ne
B
Pry::ClassCommand.inherited Ne
B
Pry::Hooks#initialize_copy Ne
B
Pry::ObjectPath#initialize Ne
B
Pry::Code#print_to_output Ne
B
Pry::InputCompleter#call Ne
B
Pry::Command.description Ne
B
Pry::CodeFile#initialize Ne
B
Pry#push_initial_binding Ne
B
Pry::Slop::Option#value= Ne
B
Pry::Prompt#initialize Ne
B
Pry::Command#output= Ne
B
Pry::Method#redefine Ne
B
Pry::Ring#initialize Ne
B
Pry::Command.banner Ne
B
Pry::Command.group Ne
B
Pry.WrappedModule Ne
B
Pry.real_path_to Ne
B
Pry#push_binding Ne
B
Pry::Code#alter Ne
B
Pry#show_result Ne
B
Pry.Method Ne
B
Pry#repl Ne
B
Pry::WrappedModule::Candidate#initialize E
B
Pry::WrappedModule#initialize E
B
Pry#ensure_correct_encoding! E
B
Pry::Slop#method_missing E
B
Pry::Method#is_a? E

Let's raise the visibility of documentation in Open Source!

This page is for pry/pry and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.