zipmark/rspec_api_documentation
Automatically generate API documentation from RSpec – Read the documentation
This page shows an evaluation of the documentation of zipmark/rspecapidocumentation.
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
|
::resource |
|
|
A
|
RspecApiDocumentation |
|
|
A
|
RspecApiDocumentation::Configuration#define_group |
|
|
A
|
RspecApiDocumentation::Writers::GeneralMarkupWriter |
|
|
A
|
RspecApiDocumentation::DSL::Callback |
|
| Show 5 more ... | ||
|
A
|
RspecApiDocumentation::DSL::Resource |
|
|
A
|
RspecApiDocumentation::DSL::Endpoint |
|
|
A
|
RspecApiDocumentation::ClientBase |
|
|
A
|
RspecApiDocumentation.configure |
|
|
A
|
RspecApiDocumentation:: … #write |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
RspecApiDocumentation::Configuration#each |
|
| Needs work | ||
|---|---|---|
| – |
| Undocumented | ||
|---|---|---|
|
U
|
RspecApiDocumentation:: … #callback |
|
|
U
|
RspecApiDocumentation:: … #method_missing |
|
|
U
|
RspecApiDocumentation:: … #method_missing |
|
|
U
|
RspecApiDocumentation::Example#method_missing |
|
|
U
|
RspecApiDocumentation:: … #trigger_callback |
|
| Show 221 more ... | ||
|
U
|
RspecApiDocumentation:: … #example_request |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#do_request |
|
|
U
|
RspecApiDocumentation::RackTestClient#do_request |
|
|
U
|
RspecApiDocumentation::DSL::Resource#no_doc |
|
|
U
|
RspecApiDocumentation::ClientBase#delete |
|
|
U
|
RspecApiDocumentation::ClientBase#patch |
|
|
U
|
RspecApiDocumentation::ClientBase#post |
|
|
U
|
RspecApiDocumentation::ClientBase#head |
|
|
U
|
RspecApiDocumentation::ClientBase#get |
|
|
U
|
RspecApiDocumentation::ClientBase#put |
|
|
U
|
RspecApiDocumentation::Curl |
|
|
U
|
RspecApiDocumentation:: … #index_file_name |
|
|
U
|
RspecApiDocumentation:: … #markup_example_class |
|
|
U
|
RspecApiDocumentation:: … #markup_example_class |
|
|
U
|
RspecApiDocumentation:: … #resource_name |
|
|
U
|
RspecApiDocumentation:: … #markup_index_class |
|
|
U
|
RspecApiDocumentation:: … ::ClassMethods.define_action |
|
|
U
|
RspecApiDocumentation:: … #markup_index_class |
|
|
U
|
RspecApiDocumentation:: … #clean_index_hash |
|
|
U
|
RspecApiDocumentation:: … #markup_example_class |
|
|
U
|
RspecApiDocumentation:: … #description |
|
|
U
|
RspecApiDocumentation:: … #parameters |
|
|
U
|
RspecApiDocumentation:: … #initialize |
|
|
U
|
RspecApiDocumentation:: … ::CombinedTextWriter.format_hash |
|
|
U
|
RspecApiDocumentation:: … #extension |
|
|
U
|
RspecApiDocumentation:: … #markup_index_class |
|
|
U
|
RspecApiDocumentation:: … #requests |
|
|
U
|
RspecApiDocumentation:: … #response_content_type |
|
|
U
|
RspecApiDocumentation:: … #parameter |
|
|
U
|
RspecApiDocumentation:: … #request_content_type |
|
|
U
|
RspecApiDocumentation:: … #example |
|
|
U
|
RspecApiDocumentation:: … #response_content_type |
|
|
U
|
RspecApiDocumentation:: … #request_content_type |
|
|
U
|
RspecApiDocumentation:: … #header |
|
|
U
|
RspecApiDocumentation:: … #write_examples |
|
|
U
|
RspecApiDocumentation:: … #api_key= |
|
|
U
|
RspecApiDocumentation:: … #example_group_started |
|
|
U
|
RspecApiDocumentation:: … #document_example |
|
|
U
|
RspecApiDocumentation:: … #api_key |
|
|
U
|
RspecApiDocumentation:: … #write |
|
|
U
|
RspecApiDocumentation:: … #write |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#response_headers |
|
|
U
|
RspecApiDocumentation::Views::MarkupExample#initialize |
|
|
U
|
RspecApiDocumentation::Writers::JsonIodocsWriter#write |
|
|
U
|
RspecApiDocumentation::Writers::JsonIndex#section_hash |
|
|
U
|
RspecApiDocumentation::RackTestClient#response_headers |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample#initialize |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample#parameters |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#request_headers |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient::ProxyApp#call |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#last_response= |
|
|
U
|
RspecApiDocumentation::RackTestClient#request_headers |
|
|
U
|
RspecApiDocumentation::ApiDocumentation#configuration |
|
|
U
|
RspecApiDocumentation::Views::MarkupExample#extension |
|
|
U
|
RspecApiDocumentation::Writers::Writer#configuration= |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#response_body |
|
|
U
|
RspecApiDocumentation::Views::MarkupExample#requests |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample#requests |
|
|
U
|
RspecApiDocumentation::Writers::ApiConfig#initialize |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample#filename |
|
|
U
|
RspecApiDocumentation::Writers::Writer#configuration |
|
|
U
|
RspecApiDocumentation::Views::MarkdownIndex#examples |
|
|
U
|
RspecApiDocumentation::Writers::JsonIndex#initialize |
|
|
U
|
RspecApiDocumentation::Views::MarkupIndex#initialize |
|
|
U
|
RspecApiDocumentation::Views::MarkupExample#filename |
|
|
U
|
RspecApiDocumentation::Writers::IndexHelper.sections |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#last_request= |
|
|
U
|
RspecApiDocumentation::RackTestClient#response_body |
|
|
U
|
RspecApiDocumentation::Views::MarkupExample#dirname |
|
|
U
|
RspecApiDocumentation::Views::TextileIndex#examples |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample#dirname |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#query_string |
|
|
U
|
RspecApiDocumentation::Writers::CombinedTextExample |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample#as_json |
|
|
U
|
RspecApiDocumentation::Configuration#client_method= |
|
|
U
|
RspecApiDocumentation::RackTestClient#query_string |
|
|
U
|
RspecApiDocumentation::Writers::CombinedTextWriter |
|
|
U
|
RspecApiDocumentation::Configuration#client_method |
|
|
U
|
RspecApiDocumentation::ApiFormatter#example_failed |
|
|
U
|
RspecApiDocumentation::Views::MarkupIndex#sections |
|
|
U
|
RspecApiDocumentation::Views::MarkupIndex#api_name |
|
|
U
|
RspecApiDocumentation::Writers::JsonIndex#sections |
|
|
U
|
RspecApiDocumentation::Writers::JsonIndex#examples |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint::ClassMethods |
|
|
U
|
RspecApiDocumentation::DSL::Resource::ClassMethods |
|
|
U
|
RspecApiDocumentation::Writers::CombinedJsonWriter |
|
|
U
|
RspecApiDocumentation::ApiFormatter#example_passed |
|
|
U
|
RspecApiDocumentation::DSL::Callback::ClassMethods |
|
|
U
|
RspecApiDocumentation::ApiDocumentation#initialize |
|
|
U
|
RspecApiDocumentation::ApiDocumentation#clear_docs |
|
|
U
|
RspecApiDocumentation::Writers::ApiConfig#as_json |
|
|
U
|
RspecApiDocumentation::DSL::Callback#callback_url |
|
|
U
|
RspecApiDocumentation::TestServer#request_headers |
|
|
U
|
RspecApiDocumentation::ClientBase#response_status |
|
|
U
|
RspecApiDocumentation::Writers::JsonIndex#as_json |
|
|
U
|
RspecApiDocumentation::Writers::Formatter.to_json |
|
|
U
|
RspecApiDocumentation::Writers::Writer.clear_docs |
|
|
U
|
RspecApiDocumentation::Writers::Writer#initialize |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#query_string |
|
|
U
|
RspecApiDocumentation::Writers::JsonWriter#write |
|
|
U
|
RspecApiDocumentation::Views::HtmlIndex#examples |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#explanation |
|
|
U
|
RspecApiDocumentation::Writers::AppendJsonWriter |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#path_params |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient::ProxyApp |
|
|
U
|
RspecApiDocumentation::DSL::Callback#destination |
|
|
U
|
RspecApiDocumentation::Writers::JsonIodocsWriter |
|
|
U
|
RspecApiDocumentation::Configuration.add_setting |
|
|
U
|
RspecApiDocumentation::TestServer#request_method |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#do_request |
|
|
U
|
RspecApiDocumentation::Writers::AppendJsonIndex |
|
|
U
|
RspecApiDocumentation::Configuration#initialize |
|
|
U
|
RspecApiDocumentation::ApiDocumentation#writers |
|
|
U
|
RspecApiDocumentation::Writers::MarkdownWriter |
|
|
U
|
RspecApiDocumentation::TestServer#request_body |
|
|
U
|
RspecApiDocumentation::ApiFormatter#initialize |
|
|
U
|
RspecApiDocumentation::ApiDocumentation#write |
|
|
U
|
RspecApiDocumentation::ApiDocumentation#index |
|
|
U
|
RspecApiDocumentation::Configuration#settings |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#status |
|
|
U
|
RspecApiDocumentation::Writers::Writer#index= |
|
|
U
|
RspecApiDocumentation::Writers::TextileWriter |
|
|
U
|
RspecApiDocumentation::Views::MarkdownExample |
|
|
U
|
RspecApiDocumentation::Views::TextileExample |
|
|
U
|
RspecApiDocumentation::Writers::Writer.write |
|
|
U
|
RspecApiDocumentation::Writers::Writer#index |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#headers |
|
|
U
|
RspecApiDocumentation::Example#configuration |
|
|
U
|
RspecApiDocumentation::RackTestClient#status |
|
|
U
|
RspecApiDocumentation::Views::MarkdownIndex |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#params |
|
|
U
|
RspecApiDocumentation::Views::MarkupExample |
|
|
U
|
RspecApiDocumentation::Writers::JsonExample |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#method |
|
|
U
|
RspecApiDocumentation::Configuration#parent |
|
|
U
|
RspecApiDocumentation::DSL::Resource#client |
|
|
U
|
RspecApiDocumentation::Configuration#groups |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#header |
|
|
U
|
RspecApiDocumentation::Writers::IndexHelper |
|
|
U
|
RspecApiDocumentation::Example#explanation |
|
|
U
|
RspecApiDocumentation::Writers::HtmlWriter |
|
|
U
|
RspecApiDocumentation::Views::TextileIndex |
|
|
U
|
RspecApiDocumentation::TestServer#context= |
|
|
U
|
RspecApiDocumentation::Example#http_method |
|
|
U
|
RspecApiDocumentation::Writers::JsonWriter |
|
|
U
|
RspecApiDocumentation::ClientBase#options= |
|
|
U
|
RspecApiDocumentation::ClientBase#context= |
|
|
U
|
RspecApiDocumentation::Views::MarkupIndex |
|
|
U
|
RspecApiDocumentation::ClientBase#context |
|
|
U
|
RspecApiDocumentation::Writers::ApiConfig |
|
|
U
|
RspecApiDocumentation::Views::HtmlExample |
|
|
U
|
RspecApiDocumentation::ClientBase#options |
|
|
U
|
RspecApiDocumentation::ApiFormatter#start |
|
|
U
|
RspecApiDocumentation::TestServer#context |
|
|
U
|
RspecApiDocumentation::DSL::Endpoint#path |
|
|
U
|
RspecApiDocumentation::Writers::JsonIndex |
|
|
U
|
RspecApiDocumentation::Writers::Formatter |
|
|
U
|
RspecApiDocumentation::Example#initialize |
|
|
U
|
RspecApiDocumentation::DSL::Resource#app |
|
|
U
|
RspecApiDocumentation::ApiFormatter#stop |
|
|
U
|
RspecApiDocumentation::Example#requests |
|
|
U
|
RspecApiDocumentation::Views::HtmlIndex |
|
|
U
|
RspecApiDocumentation::ApiDocumentation |
|
|
U
|
RspecApiDocumentation::Example#example |
|
|
U
|
RspecApiDocumentation::TestServer#call |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient |
|
|
U
|
RspecApiDocumentation::Writers::Writer |
|
|
U
|
RspecApiDocumentation::RackTestClient |
|
|
U
|
RspecApiDocumentation::Index#examples |
|
|
U
|
RspecApiDocumentation::Curl#post_data |
|
|
U
|
RspecApiDocumentation::Curl#get_data |
|
|
U
|
RspecApiDocumentation::Curl#headers= |
|
|
U
|
RspecApiDocumentation.documentations |
|
|
U
|
RspecApiDocumentation::Configuration |
|
|
U
|
RspecApiDocumentation::Curl#method= |
|
|
U
|
RspecApiDocumentation::Curl#headers |
|
|
U
|
RspecApiDocumentation::ApiFormatter |
|
|
U
|
RspecApiDocumentation.configuration |
|
|
U
|
RspecApiDocumentation::Curl#delete |
|
|
U
|
RspecApiDocumentation::Curl#method |
|
|
U
|
RspecApiDocumentation::Curl#output |
|
|
U
|
RspecApiDocumentation::Curl#host= |
|
|
U
|
RspecApiDocumentation::Curl#patch |
|
|
U
|
RspecApiDocumentation::TestServer |
|
|
U
|
RspecApiDocumentation::Curl#path= |
|
|
U
|
RspecApiDocumentation::Curl#data= |
|
|
U
|
RspecApiDocumentation::Curl#post |
|
|
U
|
RspecApiDocumentation::Curl#path |
|
|
U
|
RspecApiDocumentation::Curl#data |
|
|
U
|
RspecApiDocumentation::Curl#head |
|
|
U
|
RspecApiDocumentation::Curl#host |
|
|
U
|
RspecApiDocumentation::Curl#url |
|
|
U
|
RspecApiDocumentation::Curl#get |
|
|
U
|
RspecApiDocumentation::Curl#put |
|
|
U
|
RspecApiDocumentation::Example |
|
|
U
|
RspecApiDocumentation::Headers |
|
|
U
|
RspecApiDocumentation::Index |
|
|
U
|
RspecApiDocumentation:: … #handle_multipart_body |
|
|
U
|
RspecApiDocumentation:: … #client= |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient::ProxyApp#client |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient::ProxyApp#app= |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient::ProxyApp#app |
|
|
U
|
RspecApiDocumentation::OAuth2MACClient#access_token |
|
|
U
|
RspecApiDocumentation:: … ::AppendJsonWriter.clear_docs |
|
|
U
|
RspecApiDocumentation:: … #initialize |
|
|
U
|
RspecApiDocumentation:: … #initialize |
|
|
U
|
RspecApiDocumentation:: … #initialize |
|
|
U
|
RspecApiDocumentation:: … #extension |
|
|
U
|
RspecApiDocumentation::Views::TextileExample#initialize |
|
|
U
|
RspecApiDocumentation::Views::MarkdownExample#extension |
|
|
U
|
RspecApiDocumentation::Writers::TextileWriter#extension |
|
|
U
|
RspecApiDocumentation::Writers::AppendJsonIndex#as_json |
|
|
U
|
RspecApiDocumentation::Views::MarkdownIndex#initialize |
|
|
U
|
RspecApiDocumentation::Views::TextileExample#extension |
|
|
U
|
RspecApiDocumentation::Writers::AppendJsonWriter#write |
|
|
U
|
RspecApiDocumentation::Views::TextileIndex#initialize |
|
|
U
|
RspecApiDocumentation::Writers::HtmlWriter#extension |
|
|
U
|
RspecApiDocumentation::Views::HtmlExample#initialize |
|
|
U
|
RspecApiDocumentation::Views::HtmlExample#extension |
|
|
U
|
RspecApiDocumentation::Views::HtmlIndex#initialize |
|
|
U
|
RspecApiDocumentation::RackTestClient#headers |
|
Let's raise the visibility of documentation in Ruby!
This page is for zipmark/rspec_api_documentation 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