rspec/rspec-core
RSpec runner and formatters – Read the documentation
This page shows an evaluation of the documentation of rspec/rspec-core.
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.
| Seems really good | ||
|---|---|---|
|
A
|
RSpec::Core::Hooks#before |
|
|
A
|
RSpec::Core::Hooks#after |
|
|
A
|
RSpec::Core::SharedExampleGroup#shared_examples |
|
|
A
|
RSpec::Core::Hooks#around |
|
|
A
|
RSpec:: … #raise_errors_for_deprecations! |
|
| Show 239 more ... | ||
|
A
|
RSpec::Core::Reporter#report |
|
|
A
|
RSpec |
|
|
A
|
RSpec::Core::Configuration#disable_monkey_patching! |
|
|
A
|
RSpec::Core::Example::ExecutionResult#pending_fixed |
|
|
A
|
RSpec::Core::Example::ExecutionResult |
|
|
A
|
RSpec::Core::Example#pending |
|
|
A
|
RSpec::Core::Example#skip |
|
|
A
|
RSpec::Core::Configuration#inclusion_filter= |
|
|
A
|
RSpec::Core::Configuration#inclusion_filter |
|
|
A
|
RSpec::Core::Configuration#define_derived_metadata |
|
|
A
|
RSpec::Core::ConfigurationOptions |
|
|
A
|
RSpec::Core::Configuration |
|
|
A
|
RSpec::Core::ExampleGroup |
|
|
A
|
RSpec::Core::RakeTask |
|
|
A
|
RSpec::Core::Reporter |
|
|
A
|
RSpec::Core |
|
|
A
|
RSpec::Core::Reporter#register_listener |
|
|
A
|
RSpec::Core::Configuration#alias_it_behaves_like_to |
|
|
A
|
RSpec:: … #colorized_formatted_backtrace |
|
|
A
|
RSpec:: … #colorized_message_lines |
|
|
A
|
RSpec:: … #formatted_backtrace |
|
|
A
|
RSpec:: … #failure_notifications |
|
|
A
|
RSpec:: … #message_lines |
|
|
A
|
RSpec:: … #description |
|
|
A
|
RSpec:: … #pending_examples |
|
|
A
|
RSpec:: … #failed_examples |
|
|
A
|
RSpec:: … #exception |
|
|
A
|
RSpec:: … #notifications |
|
|
A
|
RSpec:: … #expose_current_running_example_as |
|
|
A
|
RSpec:: … #examples |
|
|
A
|
RSpec:: … #pending_exception= |
|
|
A
|
RSpec::Core::Example::ExecutionResult#pending_exception |
|
|
A
|
RSpec::Core::Example::ExecutionResult#pending_message= |
|
|
A
|
RSpec::Core::Formatters::ConsoleCodes.console_code_for |
|
|
A
|
RSpec::Core::Example::ExecutionResult#pending_message |
|
|
A
|
RSpec::Core::Example::ExecutionResult#pending_fixed= |
|
|
A
|
RSpec::Core::MemoizedHelpers::ClassMethods#subject |
|
|
A
|
RSpec::Core::Example::ExecutionResult#finished_at= |
|
|
A
|
RSpec::Core::Example::ExecutionResult#started_at= |
|
|
A
|
RSpec::Core::Configuration#alias_example_group_to |
|
|
A
|
RSpec::Core::Example::ExecutionResult#finished_at |
|
|
A
|
RSpec::Core::Configuration#expectation_frameworks |
|
|
A
|
RSpec::Core::Notifications::ExamplesNotification |
|
|
A
|
RSpec::Core::Example::ExecutionResult#started_at |
|
|
A
|
RSpec::Core::Example::ExecutionResult#exception= |
|
|
A
|
RSpec::Core::Example::ExecutionResult#run_time= |
|
|
A
|
RSpec::Core::Example::ExecutionResult#exception |
|
|
A
|
RSpec::Core::Example::ExecutionResult#run_time |
|
|
A
|
RSpec::Core::MemoizedHelpers::ClassMethods#let |
|
|
A
|
RSpec::Core::Configuration#deprecation_stream |
|
|
A
|
RSpec::Core::Configuration#default_formatter= |
|
|
A
|
RSpec::Core::Example::ExecutionResult#status= |
|
|
A
|
RSpec::Core::Example::ExecutionResult#status |
|
|
A
|
RSpec::Core::Configuration#register_ordering |
|
|
A
|
RSpec::Core::Configuration#full_description |
|
|
A
|
RSpec::Core::Configuration#alias_example_to |
|
|
A
|
RSpec::Core::Pending::SkipDeclaredInExample |
|
|
A
|
RSpec::Core::MemoizedHelpers::ClassMethods |
|
|
A
|
RSpec::Core::Formatters::ConsoleCodes.wrap |
|
|
A
|
RSpec::Core::ExampleGroup#described_class |
|
|
A
|
RSpec::Core::Configuration#mock_framework |
|
|
A
|
RSpec::Core::ConfigurationOptions#options |
|
|
A
|
RSpec::Core::Configuration#files_to_run |
|
|
A
|
RSpec::Core::Formatters::BaseFormatter |
|
|
A
|
RSpec::Core::Example#execution_result |
|
|
A
|
RSpec::Core::Configuration#formatters |
|
|
A
|
RSpec::Core::Formatters::ConsoleCodes |
|
|
A
|
RSpec::Core::Example#full_description |
|
|
A
|
RSpec::Core::Configuration#initialize |
|
|
A
|
RSpec::Core::ExampleGroup.description |
|
|
A
|
RSpec::Core::Formatters.register |
|
|
A
|
RSpec::Core::Formatters::Helpers |
|
|
A
|
RSpec::Core::SharedExampleGroup |
|
|
A
|
RSpec::Core::Configuration#libs |
|
|
A
|
RSpec::Core::Example#file_path |
|
|
A
|
RSpec::Core::Runner#run_specs |
|
|
A
|
RSpec::Core::Example#location |
|
|
A
|
RSpec::Core::MetadataFilter |
|
|
A
|
RSpec::Core::SharedContext |
|
|
A
|
RSpec::Core::Runner.run |
|
|
A
|
RSpec.current_example |
|
|
A
|
RSpec::Core::Example |
|
|
A
|
RSpec::Core::Pending |
|
|
A
|
RSpec::Core::Runner |
|
|
A
|
RSpec::Core::Hooks |
|
|
A
|
RSpec::Core::Configuration#include |
|
|
A
|
RSpec:: … #treat_symbols_as_metadata_keys_with_true_values= |
|
|
A
|
RSpec:: … #number_of_examples= |
|
|
A
|
RSpec:: … #number_of_examples |
|
|
A
|
RSpec:: … #pending_examples= |
|
|
A
|
RSpec:: … #replacement= |
|
|
A
|
RSpec:: … #failed_examples= |
|
|
A
|
RSpec:: … #pending_examples |
|
|
A
|
RSpec:: … #deprecated= |
|
|
A
|
RSpec:: … #replacement |
|
|
A
|
RSpec:: … #failed_examples |
|
|
A
|
RSpec:: … #call_site= |
|
|
A
|
RSpec:: … #deprecated |
|
|
A
|
RSpec:: … #call_site |
|
|
A
|
RSpec:: … #message= |
|
|
A
|
RSpec:: … #example_group_started |
|
|
A
|
RSpec:: … #run_all_when_everything_filtered= |
|
|
A
|
RSpec:: … #message |
|
|
A
|
RSpec:: … #run_all_when_everything_filtered |
|
|
A
|
RSpec:: … #load_time= |
|
|
A
|
RSpec:: … #duration= |
|
|
A
|
RSpec:: … #examples= |
|
|
A
|
RSpec:: … #load_time |
|
|
A
|
RSpec:: … #examples= |
|
|
A
|
RSpec:: … #duration= |
|
|
A
|
RSpec:: … #message= |
|
|
A
|
RSpec:: … #load_time= |
|
|
A
|
RSpec:: … #duration |
|
|
A
|
RSpec:: … #backtrace_exclusion_patterns= |
|
|
A
|
RSpec:: … #example= |
|
|
A
|
RSpec:: … #examples |
|
|
A
|
RSpec:: … #examples |
|
|
A
|
RSpec:: … #duration |
|
|
A
|
RSpec::Core::Configuration#backtrace_inclusion_patterns |
|
|
A
|
RSpec::Core::Configuration#backtrace_exclusion_patterns |
|
|
A
|
RSpec::Core::Notifications::StartNotification#load_time |
|
|
A
|
RSpec::Core::Notifications::ExampleNotification#example |
|
|
A
|
RSpec::Core::Notifications::MessageNotification#message |
|
|
A
|
RSpec::Core::Notifications::GroupNotification#group= |
|
|
A
|
RSpec::Core::Notifications::StartNotification#count= |
|
|
A
|
RSpec::Core::Notifications::StartNotification#count |
|
|
A
|
RSpec::Core::Notifications::GroupNotification#group |
|
|
A
|
RSpec::Core::Notifications::SeedNotification#seed= |
|
|
A
|
RSpec::Core::Notifications::SeedNotification#used= |
|
|
A
|
RSpec::Core::Notifications::SeedNotification#seed |
|
|
A
|
RSpec::Core::Notifications::SeedNotification#used |
|
|
A
|
RSpec::Core::Configuration#expectation_framework= |
|
|
A
|
RSpec::Core::Configuration#expose_dsl_globally= |
|
|
A
|
RSpec::Core::Configuration#deprecation_stream= |
|
|
A
|
RSpec::Core::Configuration#failure_exit_code= |
|
|
A
|
RSpec::Core::Configuration#full_description= |
|
|
A
|
RSpec::Core::Configuration#exclusion_filter= |
|
|
A
|
RSpec::Core::Formatters::BaseFormatter#start |
|
|
A
|
RSpec::Core::Configuration#failure_exit_code |
|
|
A
|
RSpec::Core::Configuration#default_formatter |
|
|
A
|
RSpec::Core::Formatters::BaseFormatter#close |
|
|
A
|
RSpec::Core::Configuration#profile_examples= |
|
|
A
|
RSpec::Core::Configuration#exclusion_filter |
|
|
A
|
RSpec::Core::ConfigurationOptions#configure |
|
|
A
|
RSpec::Core::Configuration#mock_framework= |
|
|
A
|
RSpec::Core::Configuration#error_stream= |
|
|
A
|
RSpec::Core::Configuration#default_path= |
|
|
A
|
RSpec::Core::Configuration#output_stream |
|
|
A
|
RSpec::Core::Configuration#default_path |
|
|
A
|
RSpec::Core::Configuration#error_stream |
|
|
A
|
RSpec::Core::RakeTask#failure_message= |
|
|
A
|
RSpec::Core::Configuration#fail_fast= |
|
|
A
|
RSpec::Core::RakeTask#failure_message |
|
|
A
|
RSpec::Core::RakeTask#fail_on_error= |
|
|
A
|
RSpec::Core::Example::Procsy#example |
|
|
A
|
RSpec::Core::Configuration#fail_fast |
|
|
A
|
RSpec::Core::Configuration#warnings= |
|
|
A
|
RSpec::Core::Configuration#drb_port= |
|
|
A
|
RSpec::Core::Configuration#dry_run= |
|
|
A
|
RSpec::Core::Configuration#drb_port |
|
|
A
|
RSpec::Core::Configuration#requires |
|
|
A
|
RSpec::Core::RakeTask#fail_on_error |
|
|
A
|
RSpec::Core::Configuration#dry_run |
|
|
A
|
RSpec::Core::Configuration#pattern |
|
|
A
|
RSpec::Core::Example#example_group |
|
|
A
|
RSpec::Core::RakeTask#rspec_path= |
|
|
A
|
RSpec::Core::Configuration#order= |
|
|
A
|
RSpec::Core::RakeTask#rspec_opts= |
|
|
A
|
RSpec::Core::RakeTask#rspec_path |
|
|
A
|
RSpec::Core::Configuration#seed= |
|
|
A
|
RSpec::Core::Example#description |
|
|
A
|
RSpec::Core::RakeTask#ruby_opts= |
|
|
A
|
RSpec::Core::RakeTask#rspec_opts |
|
|
A
|
RSpec::Core::Configuration#drb= |
|
|
A
|
RSpec::Core::Configuration#seed |
|
|
A
|
RSpec::Core::RakeTask#ruby_opts |
|
|
A
|
RSpec::Core::RakeTask#verbose= |
|
|
A
|
RSpec::Core::Configuration#drb |
|
|
A
|
RSpec::Core::RakeTask#pattern= |
|
|
A
|
RSpec::Core::RakeTask#verbose |
|
|
A
|
RSpec::Core::RakeTask#pattern |
|
|
A
|
RSpec::Core::RakeTask#name= |
|
|
A
|
RSpec::Core::RakeTask#name |
|
|
A
|
RSpec::Core::Runner.invoke |
|
|
A
|
RSpec::Core::Runner#setup |
|
|
A
|
RSpec::Core::Runner#run |
|
|
A
|
RSpec.reset |
|
|
A
|
RSpec::Core::Configuration#extend |
|
|
A
|
RSpec:: … ::PendingExampleFixedNotification |
|
|
A
|
RSpec:: … #backtrace_inclusion_patterns= |
|
|
A
|
RSpec::Core::Notifications::FailedExampleNotification |
|
|
A
|
RSpec::Core::Notifications::DeprecationNotification |
|
|
A
|
RSpec::Core::ExampleGroup.it_should_behave_like |
|
|
A
|
RSpec::Core::Notifications::MessageNotification |
|
|
A
|
RSpec::Core::Notifications::ProfileNotification |
|
|
A
|
RSpec::Core::Notifications::ExampleNotification |
|
|
A
|
RSpec::Core::Notifications::SummaryNotification |
|
|
A
|
RSpec::Core::Notifications::GroupNotification |
|
|
A
|
RSpec::Core::Notifications::StartNotification |
|
|
A
|
RSpec::Core::Notifications::SeedNotification |
|
|
A
|
RSpec::Core::Formatters::BaseTextFormatter |
|
|
A
|
RSpec::Core::Configuration#full_backtrace= |
|
|
A
|
RSpec::Core::Configuration#output_stream= |
|
|
A
|
RSpec::Core::ExampleGroup.it_behaves_like |
|
|
A
|
RSpec::Core::MemoizedHelpers#is_expected |
|
|
A
|
RSpec::Core::MemoizedHelpers#should_not |
|
|
A
|
RSpec::Core::Configuration#add_setting |
|
|
A
|
RSpec::Core::MemoizedHelpers#subject |
|
|
A
|
RSpec::Core::MemoizedHelpers#should |
|
|
A
|
RSpec::Core::Configuration#pattern= |
|
|
A
|
RSpec::Core::ExampleGroup.metadata |
|
|
A
|
RSpec::Core::Configuration#color= |
|
|
A
|
RSpec::Core::Configuration#color |
|
|
A
|
RSpec::Core::Example#exception |
|
|
A
|
RSpec::Core::Example#metadata |
|
|
A
|
RSpec::Core::Example::Procsy |
|
|
A
|
RSpec::Core::MemoizedHelpers |
|
|
A
|
RSpec::Core::Runner.autorun |
|
|
A
|
RSpec::Core::Formatters |
|
|
A
|
RSpec::Core::Metadata |
|
|
A
|
RSpec.configuration |
|
|
A
|
RSpec::Core::DSL |
|
|
A
|
RSpec.configure |
|
|
A
|
RSpec::Core::Pending#pending |
|
|
A
|
RSpec:: … #colorized_message_lines |
|
|
A
|
RSpec:: … #message_lines |
|
|
A
|
RSpec:: … #description |
|
|
A
|
RSpec::Core::Hooks#append_before |
|
|
A
|
RSpec::Core::Hooks#prepend_after |
|
|
A
|
RSpec::Core::Version |
|
|
A
|
RSpec:: … #example= |
|
|
A
|
RSpec:: … #example |
|
|
A
|
RSpec:: … #example= |
|
|
A
|
RSpec:: … ::TopLevelDSL.remove_globally! |
|
|
A
|
RSpec:: … #example |
|
|
A
|
RSpec:: … ::TopLevelDSL.expose_globally! |
|
|
A
|
RSpec::Core::Formatters::BaseTextFormatter#close |
|
|
A
|
RSpec::Core::DSL.expose_globally! |
|
|
A
|
RSpec::Core::DSL.remove_globally! |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
RSpec::Core::MemoizedHelpers::ClassMethods#subject! |
|
|
B
|
RSpec::Core::MemoizedHelpers::ClassMethods#let! |
|
|
B
|
RSpec::Core::Configuration#filter_run_including |
|
|
B
|
RSpec::Core::Configuration#add_formatter |
|
|
B
|
RSpec::Core::Hooks#prepend_before |
|
| Show 39 more ... | ||
|
B
|
RSpec::Core::Hooks#append_after |
|
|
B
|
RSpec::Core::Configuration#filter_run_excluding |
|
|
B
|
RSpec::Core::Configuration#expect_with |
|
|
B
|
RSpec::Core::ExampleGroup.describe |
|
|
B
|
RSpec::Core::ExampleGroup.include_examples |
|
|
B
|
RSpec::Core::ExampleGroup.include_context |
|
|
B
|
RSpec::Core::Configuration#format_docstrings |
|
|
B
|
RSpec::Core::ExampleGroup.fdescribe |
|
|
B
|
RSpec::Core::ExampleGroup.xdescribe |
|
|
B
|
RSpec::Core::ExampleGroup.fcontext |
|
|
B
|
RSpec::Core::ExampleGroup.xcontext |
|
|
B
|
RSpec::Core::ExampleGroup.context |
|
|
B
|
RSpec:: … #example_group_finished |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#example_started |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#example_pending |
|
|
B
|
RSpec::Core::Formatters::ProfileFormatter#dump_profile |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#example_passed |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#example_failed |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#dump_failures |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#dump_pending |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#dump_profile |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#dump_summary |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#start_dump |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#message |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#stop |
|
|
B
|
RSpec::Core::Configuration#pending_color |
|
|
B
|
RSpec::Core::Configuration#failure_color |
|
|
B
|
RSpec::Core::Configuration#success_color |
|
|
B
|
RSpec::Core::Configuration#default_color |
|
|
B
|
RSpec::Core::Configuration#detail_color |
|
|
B
|
RSpec::Core::Configuration#fixed_color |
|
|
B
|
RSpec::Core::Configuration#mock_with |
|
|
B
|
RSpec::Core::Formatters::BaseFormatter#initialize |
|
|
B
|
RSpec::Core::ConfigurationOptions#initialize |
|
|
B
|
RSpec::Core::ExampleGroup.run |
|
|
B
|
RSpec::Core::Pending#skip |
|
|
B
|
RSpec:: … #dump_failures |
|
|
B
|
RSpec::Core::Formatters::BaseTextFormatter#dump_summary |
|
|
B
|
RSpec::Core::Formatters::BaseTextFormatter#message |
|
| Needs work | ||
|---|---|---|
|
C
|
RSpec::Core::ExampleGroup.xexample |
|
|
C
|
RSpec::Core::ExampleGroup.fspecify |
|
|
C
|
RSpec::Core::ExampleGroup.xspecify |
|
|
C
|
RSpec::Core::ExampleGroup.fexample |
|
|
C
|
RSpec::Core::ExampleGroup.pending |
|
| Show 17 more ... | ||
|
C
|
RSpec::Core::ExampleGroup.focus |
|
|
C
|
RSpec::Core::ExampleGroup.skip |
|
|
C
|
RSpec::Core::ExampleGroup.fit |
|
|
C
|
RSpec::Core::ExampleGroup.xit |
|
|
C
|
RSpec::Core::ExampleGroup.specify |
|
|
C
|
RSpec::Core::ExampleGroup.example |
|
|
C
|
RSpec::Core::ExampleGroup.it |
|
|
C
|
RSpec::Core::ExampleGroup.example_group |
|
|
C
|
RSpec::Core::Configuration#default_color= |
|
|
C
|
RSpec::Core::Configuration#failure_color= |
|
|
C
|
RSpec::Core::Configuration#success_color= |
|
|
C
|
RSpec::Core::Configuration#pending_color= |
|
|
C
|
RSpec::Core::Configuration#detail_color= |
|
|
C
|
RSpec::Core::Configuration#fixed_color= |
|
|
C
|
RSpec:: … #fully_formatted_pending_examples |
|
|
C
|
RSpec:: … #fully_formatted_failed_examples |
|
|
C
|
RSpec:: … #fully_formatted |
|
| Undocumented | ||
|---|---|---|
|
U
|
RSpec::Core::RakeTask#initialize |
|
|
U
|
RSpec::Core::Example::Procsy#initialize |
|
|
U
|
RSpec:: … #initialize |
|
|
U
|
RSpec::Core::Pending::SkipDeclaredInExample#initialize |
|
|
U
|
RSpec::Core::Formatters::BaseFormatter#example_group= |
|
| Show 6 more ... | ||
|
U
|
RSpec::Core::Pending::SkipDeclaredInExample#argument |
|
|
U
|
RSpec::Core::Formatters::BaseFormatter#example_group |
|
|
U
|
RSpec::Core::Formatters::BaseFormatter#output |
|
|
U
|
RSpec::Core::Reporter#initialize |
|
|
U
|
RSpec::Core::Example::Procsy#run |
|
|
U
|
RSpec::Core::Runner#initialize |
|
Let's raise the visibility of documentation in Ruby!
This page is for rspec/rspec-core and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
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.
nch Pages