razum2um/lurker
Get pretty, documented and visible API – Read the documentation
This page shows an evaluation of the documentation of razum2um/lurker.
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
|
Lurker::Endpoint |
|
|
A
|
Lurker::EndpointPresenter |
|
|
A
|
Lurker::Service |
|
|
A
|
Lurker::ResponseCodePresenter |
|
|
A
|
Lurker::Server::TryStatic |
|
| Show 10 more ... | ||
|
A
|
Lurker::ServicePresenter |
|
|
A
|
Lurker::SchemaPresenter |
|
|
A
|
Lurker::JamlDescriptor |
|
|
A
|
Lurker::Cli |
|
|
A
|
Lurker::EndpointPresenter#named_path |
|
|
A
|
Lurker::RenderingController#request |
|
|
A
|
Lurker::RenderingController#cookies |
|
|
A
|
Lurker::RenderingController#params |
|
|
A
|
Lurker::RenderingController#flash |
|
|
A
|
Lurker::EndpointPresenter#path |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Lurker::ServicePresenter#to_html |
|
|
B
|
Lurker::Service#open |
|
|
B
|
Lurker::Endpoint#set_additional_properties_false_on |
|
| Needs work | ||
|---|---|---|
| – |
| Undocumented | ||
|---|---|---|
|
U
|
Lurker::Endpoint#consume! |
|
|
U
|
Lurker::Service#verify! |
|
|
U
|
Lurker |
|
|
U
|
Lurker::SchemaModifier::Array#append! |
|
|
U
|
Lurker::SchemaModifier::Array#merge! |
|
| Show 199 more ... | ||
|
U
|
Lurker::SchemaModifier::Hash#merge! |
|
|
U
|
Lurker::SchemaModifier::Atom#merge! |
|
|
U
|
Lurker::SchemaModifier.append! |
|
|
U
|
Lurker::SchemaModifier#append! |
|
|
U
|
Lurker::SchemaModifier#merge! |
|
|
U
|
Lurker::SchemaModifier.merge! |
|
|
U
|
Lurker::Endpoint#persist! |
|
|
U
|
Lurker::Service#persist! |
|
|
U
|
Lurker::Schema#ordered! |
|
|
U
|
Lurker::Endpoint#raise_errors! |
|
|
U
|
Lurker::Schema#method_missing |
|
|
U
|
Lurker::ErbSchemaContext#allowed |
|
|
U
|
Lurker::BasePresenter#render |
|
|
U
|
Lurker.decide_success_with |
|
|
U
|
Lurker::Spy#initialize |
|
|
U
|
Lurker.decide_success |
|
|
U
|
Lurker::Spy.on |
|
|
U
|
Lurker:: … ::LurkerSession#process |
|
|
U
|
Lurker::SpecHelper::Rails::ClassMethods::LurkerSession |
|
|
U
|
Lurker::EndpointPresenter#successful_response_codes |
|
|
U
|
Lurker::EndpointPresenter#failure_response_codes |
|
|
U
|
Lurker::EndpointPresenter#example_from_object |
|
|
U
|
Lurker::EndpointPresenter#example_from_schema |
|
|
U
|
Lurker::EndpointPresenter#endpoint_presenter= |
|
|
U
|
Lurker::EndpointPresenter#response_parameters |
|
|
U
|
Lurker::EndpointPresenter#request_parameters |
|
|
U
|
Lurker::EndpointPresenter#service_presenter= |
|
|
U
|
Lurker::EndpointPresenter#example_from_array |
|
|
U
|
Lurker::ServicePresenter#endpoints_by_prefix |
|
|
U
|
Lurker::EndpointPresenter#endpoint_presenter |
|
|
U
|
Lurker::Response.build_from_action_dispatch |
|
|
U
|
Lurker::RenderingController#tag_with_anchor |
|
|
U
|
Lurker::SpecHelper::Rails::ClassMethods#new |
|
|
U
|
Lurker::EndpointPresenter#service_presenter |
|
|
U
|
Lurker::EndpointPresenter#example_from_atom |
|
|
U
|
Lurker::ResponseCodePresenter#response_code |
|
|
U
|
Lurker::EndpointPresenter#example_response |
|
|
U
|
Lurker::Request.build_from_action_dispatch |
|
|
U
|
Lurker::ResponseCodePresenter#description |
|
|
U
|
Lurker::EndpointPresenter#example_request |
|
|
U
|
Lurker::EndpointPresenter#response_codes |
|
|
U
|
Lurker::SchemaModifier::Array#initialize |
|
|
U
|
Lurker::EndpointPresenter#verb_colorname |
|
|
U
|
Lurker::ServicePresenter#default_domain |
|
|
U
|
Lurker::EndpointPresenter#relative_path |
|
|
U
|
Lurker::SchemaPresenter#properties_html |
|
|
U
|
Lurker::SpecHelper::Rails::ClassMethods |
|
|
U
|
Lurker::SchemaModifier::Hash#initialize |
|
|
U
|
Lurker::SchemaModifier::Atom#initialize |
|
|
U
|
Lurker::BasePresenter#tag_with_anchor |
|
|
U
|
Lurker::ServicePresenter#name_as_link |
|
|
U
|
Lurker::ResponseCodePresenter#to_html |
|
|
U
|
Lurker::Endpoint#response_parameters |
|
|
U
|
Lurker::BasePresenter#html_directory |
|
|
U
|
Lurker::ErbSchemaContext#get_binding |
|
|
U
|
Lurker::Server::TryStatic#initialize |
|
|
U
|
Lurker::ResponseCodePresenter#status |
|
|
U
|
Lurker::Endpoint#request_parameters |
|
|
U
|
Lurker::EndpointPresenter#root_path |
|
|
U
|
Lurker::Cli.precompiled_static_root |
|
|
U
|
Lurker::RefObject#schema_descriptor |
|
|
U
|
Lurker::EndpointPresenter#base_path |
|
|
U
|
Lurker::BasePresenter#url_base_path |
|
|
U
|
Lurker::SchemaPresenter#schema_slug |
|
|
U
|
Lurker::EndpointPresenter#form_verb |
|
|
U
|
Lurker::EndpointPresenter#endpoint= |
|
|
U
|
Lurker::ServicePresenter#slug_name |
|
|
U
|
Lurker::ServicePresenter#endpoints |
|
|
U
|
Lurker::EndpointPresenter#endpoint |
|
|
U
|
Lurker::SchemaPresenter#items_html |
|
|
U
|
Lurker::JamlDescriptor#initialize |
|
|
U
|
Lurker::SchemaPresenter#enum_html |
|
|
U
|
Lurker::Service#opened_endpoints= |
|
|
U
|
Lurker::Endpoint#current_scaffold |
|
|
U
|
Lurker::BasePresenter#get_binding |
|
|
U
|
Lurker::SchemaModifier#initialize |
|
|
U
|
Lurker::Service#fix_endpoint_path |
|
|
U
|
Lurker::EndpointPresenter#zws_ify |
|
|
U
|
Lurker::Endpoint#consume_response |
|
|
U
|
Lurker::EndpointPresenter#to_html |
|
|
U
|
Lurker::Service#service_filename |
|
|
U
|
Lurker::Endpoint#consume_request |
|
|
U
|
Lurker::BasePresenter#index_path |
|
|
U
|
Lurker::ServicePresenter#service |
|
|
U
|
Lurker::BasePresenter#render_erb |
|
|
U
|
Lurker::ServicePresenter#domains |
|
|
U
|
Lurker::BasePresenter#initialize |
|
|
U
|
Lurker::EndpointPresenter#prefix |
|
|
U
|
Lurker::Service#opened_endpoints |
|
|
U
|
Lurker::JsonPresenter#initialize |
|
|
U
|
Lurker::EndpointPresenter#title |
|
|
U
|
Lurker::Request.reject_internal |
|
|
U
|
Lurker::SchemaPresenter#example |
|
|
U
|
Lurker::Endpoint#response_codes |
|
|
U
|
Lurker::Service.default_service |
|
|
U
|
Lurker::SchemaPresenter#to_html |
|
|
U
|
Lurker::EndpointPresenter#verb |
|
|
U
|
Lurker::Service#endpoint_paths |
|
|
U
|
Lurker::FormBuilder#initialize |
|
|
U
|
Lurker::Server::TryStatic#call |
|
|
U
|
Lurker::ServicePresenter#title |
|
|
U
|
Lurker::SchemaPresenter#format |
|
|
U
|
Lurker::Endpoint#endpoint_path |
|
|
U
|
Lurker::BasePresenter#css_path |
|
|
U
|
Lurker::Endpoint#query_params |
|
|
U
|
Lurker::BasePresenter#options |
|
|
U
|
Lurker::EndpointPresenter#url |
|
|
U
|
Lurker::JsonPresenter#to_html |
|
|
U
|
Lurker::SchemaModifier::Array |
|
|
U
|
Lurker::SchemaPresenter#type |
|
|
U
|
Lurker::RefObject#initialize |
|
|
U
|
Lurker::ServicePresenter#url |
|
|
U
|
Lurker::Endpoint#description |
|
|
U
|
Lurker::SchemaModifier::Atom |
|
|
U
|
Lurker::SchemaModifier::Hash |
|
|
U
|
Lurker::Service#service_path |
|
|
U
|
Lurker::Service#description |
|
|
U
|
Lurker::RenderingController |
|
|
U
|
Lurker::Endpoint#url_params |
|
|
U
|
Lurker::Service#service_dir |
|
|
U
|
Lurker::JamlDescriptor#read |
|
|
U
|
Lurker::Endpoint#extensions |
|
|
U
|
Lurker::Endpoint#initialize |
|
|
U
|
Lurker::RefObject#abs_path |
|
|
U
|
Lurker::Service#discussion |
|
|
U
|
Lurker::Request.route_name |
|
|
U
|
Lurker::Service#initialize |
|
|
U
|
Lurker::JsonPresenter#json |
|
|
U
|
Lurker::Sandbox#initialize |
|
|
U
|
Lurker::Schema#extensions |
|
|
U
|
Lurker::Service#endpoints |
|
|
U
|
Lurker::Spy#endpoint_path |
|
|
U
|
Lurker::Schema#initialize |
|
|
U
|
Lurker::Service#base_path |
|
|
U
|
Lurker::Endpoint#errors= |
|
|
U
|
Lurker::RefObject#schema |
|
|
U
|
Lurker::ErbSchemaContext |
|
|
U
|
Lurker::Endpoint#service |
|
|
U
|
Lurker::Cli#origin_path= |
|
|
U
|
Lurker::FormBuilder#html |
|
|
U
|
Lurker::Service#path_for |
|
|
U
|
Lurker::Cli.source_root |
|
|
U
|
Lurker::Service#domains |
|
|
U
|
Lurker::Schema#write_to |
|
|
U
|
Lurker::Endpoint#errors |
|
|
U
|
Lurker::Cli#origin_path |
|
|
U
|
Lurker::Endpoint#prefix |
|
|
U
|
Lurker::Endpoint#schema |
|
|
U
|
Lurker::Schema#to_yaml |
|
|
U
|
Lurker::Server.to_rack |
|
|
U
|
Lurker::Validator#open |
|
|
U
|
Lurker::Spy#extensions |
|
|
U
|
Lurker::SchemaModifier |
|
|
U
|
Lurker::Service#schema |
|
|
U
|
Lurker::JsonPresenter |
|
|
U
|
Lurker::Endpoint#verb |
|
|
U
|
Lurker::Endpoint#path |
|
|
U
|
Lurker::Spy#response= |
|
|
U
|
Lurker::BasePresenter |
|
|
U
|
Lurker::Service#name |
|
|
U
|
Lurker::Cli#content= |
|
|
U
|
Lurker.service_path= |
|
|
U
|
Lurker::Sandbox#call |
|
|
U
|
Lurker::Spy#response |
|
|
U
|
Lurker::Spy#request= |
|
|
U
|
Lurker::Cli#content |
|
|
U
|
Lurker::Spy#request |
|
|
U
|
Lurker::Spy#service |
|
|
U
|
Lurker::FormBuilder |
|
|
U
|
Lurker::Cli#convert |
|
|
U
|
Lurker::Spy.current |
|
|
U
|
Lurker.safe_require |
|
|
U
|
Lurker.service_path |
|
|
U
|
Lurker::Spy#suffix |
|
|
U
|
Lurker::Validator |
|
|
U
|
Lurker::RefObject |
|
|
U
|
Lurker::Spy#block |
|
|
U
|
Lurker::Spy#call |
|
|
U
|
Lurker::Response |
|
|
U
|
Lurker::Sandbox |
|
|
U
|
Lurker::Request |
|
|
U
|
Lurker::Server |
|
|
U
|
Lurker::Schema |
|
|
U
|
Lurker::Spy |
|
|
U
|
Lurker::BasePresenter#rendering_controller |
|
|
U
|
Lurker::BasePresenter#path_for_template |
|
|
U
|
Lurker::ServicePresenter#initialize |
|
|
U
|
Lurker::Endpoint#validate_response |
|
|
U
|
Lurker::Schema#serialized_for_diff |
|
|
U
|
Lurker::Endpoint#stringify_keys |
|
|
U
|
Lurker::Endpoint#build_schema |
|
|
U
|
Lurker::Endpoint#load_schema |
|
|
U
|
Lurker::Endpoint#word_wrap |
|
|
U
|
Lurker::Endpoint#load_file |
|
|
U
|
Lurker::Endpoint#validate |
|
|
U
|
Lurker::ResponseCodePresenter#initialize |
|
|
U
|
Lurker::EndpointPresenter#initialize |
|
|
U
|
Lurker::SchemaPresenter#initialize |
|
|
U
|
Lurker::SpecHelper::Rspec |
|
Let's raise the visibility of documentation in Ruby!
This page is for razum2um/lurker 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