haml/haml
HTML Abstraction Markup Language - A Markup Haiku – Read the documentation
This page shows an evaluation of the documentation of haml/haml.
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
|
Haml::Helpers#haml_tag |
|
|
A
|
Haml::Engine#render |
|
|
A
|
Haml |
|
|
A
|
Haml::Buffer#rstrip! |
|
|
A
|
Haml::Helpers::ActionViewExtensions#page_class |
|
| Show 134 more ... | ||
|
A
|
Haml::Helpers#find_and_preserve |
|
|
A
|
Haml::Exec::Generic#parse! |
|
|
A
|
Haml::Helpers#preserve |
|
|
A
|
Haml::Util#balance |
|
|
A
|
Haml::Options |
|
|
A
|
Haml::Helpers::ErrorReturn#to_s |
|
|
A
|
Haml::Helpers#capture_haml |
|
|
A
|
Haml::Engine#render_proc |
|
|
A
|
Haml::Buffer.merge_attrs |
|
|
A
|
Haml::Engine#def_method |
|
|
A
|
Haml::Helpers |
|
|
A
|
Haml::Buffer |
|
|
A
|
Haml::Helpers#haml_tag_if |
|
|
A
|
Haml::Helpers::ActionViewExtensions |
|
|
A
|
Haml::Helpers::ErrorReturn#inspect |
|
|
A
|
Haml::Filters::SassRailsTemplate |
|
|
A
|
Haml::Options.buffer_option_keys |
|
|
A
|
Haml::Filters::ScssRailsTemplate |
|
|
A
|
Haml::Helpers#init_haml_helpers |
|
|
A
|
Haml::Util#check_haml_encoding |
|
|
A
|
Haml::Buffer#capture_position= |
|
|
A
|
Haml::Buffer#capture_position |
|
|
A
|
Haml::Util#human_indentation |
|
|
A
|
Haml::Options.valid_formats |
|
|
A
|
Haml::Compiler#precompiled |
|
|
A
|
Haml::Helpers::ErrorReturn |
|
|
A
|
Haml::Helpers#haml_indent |
|
|
A
|
Haml::Filters::Javascript |
|
|
A
|
Haml::Engine#indentation= |
|
|
A
|
Haml::Helpers#escape_once |
|
|
A
|
Haml::Helpers#html_escape |
|
|
A
|
Haml::Helpers#html_attrs |
|
|
A
|
Haml::Exec::Generic#to_s |
|
|
A
|
Haml::Engine#indentation |
|
|
A
|
Haml::Options#for_buffer |
|
|
A
|
Haml::Template#options= |
|
|
A
|
Haml::Buffer#tabulation |
|
|
A
|
Haml::Helpers#with_tabs |
|
|
A
|
Haml::Options.defaults |
|
|
A
|
Haml::Util#inspect_obj |
|
|
A
|
Haml::Template#options |
|
|
A
|
Haml::Helpers#surround |
|
|
A
|
Haml::Util#caller_info |
|
|
A
|
Haml::Helpers#tab_down |
|
|
A
|
Haml::Helpers::XssMods |
|
|
A
|
Haml::Filters::Escaped |
|
|
A
|
Haml::Helpers#precede |
|
|
A
|
Haml::Helpers#succeed |
|
|
A
|
Haml::Engine#options= |
|
|
A
|
Haml::Helpers#list_of |
|
|
A
|
Haml::Filters#defined |
|
|
A
|
Haml::Helpers#tab_up |
|
|
A
|
Haml::Util#html_safe |
|
|
A
|
Haml::Filters::Plain |
|
|
A
|
Haml::Filters::Cdata |
|
|
A
|
Haml::Buffer#buffer= |
|
|
A
|
Haml::Engine#options |
|
|
A
|
Haml::Buffer#buffer |
|
|
A
|
Haml::Buffer#upper= |
|
|
A
|
Haml::Filters::Base |
|
|
A
|
Haml::Filters::Ruby |
|
|
A
|
Haml::Util#powerset |
|
|
A
|
Haml::Exec::Generic |
|
|
A
|
Haml::Buffer#upper |
|
|
A
|
Haml::Filters::Css |
|
|
A
|
Haml::Filters::Erb |
|
|
A
|
Haml::Error#line |
|
|
A
|
Haml::Exec::Haml |
|
|
A
|
Haml::Filters |
|
|
A
|
Haml::Plugin |
|
|
A
|
Haml::Engine |
|
|
A
|
Haml::Error |
|
|
A
|
Haml::Util |
|
|
A
|
Haml::Helpers::XssMods#haml_indent_with_haml_xss |
|
|
A
|
Haml::Options#hyphenate_data_attrs= |
|
|
A
|
Haml::Options#hyphenate_data_attrs |
|
|
A
|
Haml::Options#remove_whitespace |
|
|
A
|
Haml::Options#compiler_class= |
|
|
A
|
Haml::Filters::Base.included |
|
|
A
|
Haml::Options#suppress_eval= |
|
|
A
|
Haml::Options#compiler_class |
|
|
A
|
Haml::Options#parser_class= |
|
|
A
|
Haml::Options#suppress_eval |
|
|
A
|
Haml::Options#escape_attrs= |
|
|
A
|
Haml::Options#escape_html= |
|
|
A
|
Haml::Options#escape_attrs |
|
|
A
|
Haml::Options#parser_class |
|
|
A
|
Haml::Options#attr_wrapper |
|
|
A
|
Haml::Helpers#haml_concat |
|
|
A
|
Haml::Options#escape_html |
|
|
A
|
Haml::Options#mime_type= |
|
|
A
|
Haml::Options#autoclose= |
|
|
A
|
Haml::Buffer#adjust_tabs |
|
|
A
|
Haml::Exec::Generic#puts |
|
|
A
|
Haml::Buffer#tabulation= |
|
|
A
|
Haml::Options#filename= |
|
|
A
|
Haml::Options#autoclose |
|
|
A
|
Haml::Options#mime_type |
|
|
A
|
Haml::Options#preserve= |
|
|
A
|
Haml::Options#encoding |
|
|
A
|
Haml::Options#preserve |
|
|
A
|
Haml::Buffer#push_text |
|
|
A
|
Haml::Options#filename |
|
|
A
|
Haml::Options#format |
|
|
A
|
Haml::Options#trace= |
|
|
A
|
Haml::Options#cdata= |
|
|
A
|
Haml::Options#trace |
|
|
A
|
Haml::Options#ugly= |
|
|
A
|
Haml::Options#cdata |
|
|
A
|
Haml::Options#line= |
|
|
A
|
Haml::Options#line |
|
|
A
|
Haml::Options#ugly |
|
|
A
|
Haml::Filters#remove_filter |
|
|
A
|
Haml:: … #with_raw_haml_concat |
|
|
A
|
Haml::Filters::Base#render_with_options |
|
|
A
|
Haml::Filters#register_tilt_filter |
|
|
A
|
Haml::Util#handle_interpolation |
|
|
A
|
Haml::Exec::Generic#get_line |
|
|
A
|
Haml::Filters::Base#compile |
|
|
A
|
Haml::Util#silence_warnings |
|
|
A
|
Haml::Filters::Base#render |
|
|
A
|
Haml::Util#check_encoding |
|
|
A
|
Haml::Exec::Generic#color |
|
|
A
|
Haml::Exec::Generic#parse |
|
|
A
|
Haml::Engine#initialize |
|
|
A
|
Haml::Filters::Preserve |
|
|
A
|
Haml::Helpers#non_haml |
|
|
A
|
Haml::Buffer#options= |
|
|
A
|
Haml::Buffer#options |
|
|
A
|
Haml::Exec::Generic#process_result |
|
|
A
|
Haml::Exec::Generic#set_opts |
|
|
A
|
ActionView::Helpers::HamlSupport#haml_buffer |
|
|
A
|
Haml::Exec::Haml#process_result |
|
|
A
|
Haml::Exec::Haml#set_opts |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Haml::Helpers::XssMods#find_and_preserve_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#capture_haml_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#haml_tag_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#preserve_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#list_of_with_haml_xss |
|
| Show 16 more ... | ||
|
B
|
Haml::Buffer#format_script |
|
|
B
|
Haml::Helpers::XssMods#escape_once_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#surround_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#precede_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#succeed_with_haml_xss |
|
|
B
|
Haml::Filters::Base#internal_compile |
|
|
B
|
Haml::Options#[]= |
|
|
B
|
Haml::Options#[] |
|
|
B
|
Haml::Helpers::XssMods#haml_concat_with_haml_xss |
|
|
B
|
Haml::Helpers::XssMods#html_escape_with_haml_xss |
|
|
B
|
Haml::Compiler#precompiled_with_ambles |
|
|
B
|
Haml::Exec::Generic#initialize |
|
|
B
|
Haml::Buffer#initialize |
|
|
B
|
Haml::Error#initialize |
|
|
B
|
Haml::Exec::Generic#puts_action |
|
|
B
|
Haml::Exec::Haml#initialize |
|
| Needs work | ||
|---|---|---|
|
C
|
Haml::Buffer#active= |
|
| Undocumented | ||
|---|---|---|
|
U
|
ActionView:: … #with_output_buffer_with_haml_xss |
|
|
U
|
ActionView:: … #form_tag_with_haml_xss |
|
|
U
|
ActionView::Helpers::FormHelper#form_for_with_haml_xss |
|
|
U
|
ActionView::Helpers::FormTagHelper#form_tag_with_haml |
|
|
U
|
ActionView::Helpers::TagHelper#content_tag_with_haml |
|
| Show 61 more ... | ||
|
U
|
ActionView::Helpers::CaptureHelper#capture_with_haml |
|
|
U
|
ActionView::Base#render_with_haml |
|
|
U
|
Haml:: … #precompiled_method_return_value_with_haml_xss |
|
|
U
|
ActionView:: … #safe_concat_with_haml_xss |
|
|
U
|
ActionView::Helpers::TextHelper#concat_with_haml_xss |
|
|
U
|
ActionView::Helpers::InstanceTag#content_tag |
|
|
U
|
ActionView::Base#set_output_buffer_with_haml |
|
|
U
|
ActionView::Base#output_buffer_with_haml |
|
|
U
|
Haml::ErubisTemplateHandler#initialize |
|
|
U
|
Haml::Filters::SassRailsTemplate#render |
|
|
U
|
Haml::Options#initialize |
|
|
U
|
Haml::Buffer#attributes |
|
|
U
|
Haml::Error.message |
|
|
U
|
Haml.init_rails |
|
|
U
|
Haml::Compiler |
|
|
U
|
Haml::Parser |
|
|
U
|
Haml:: … #precompiled_method_return_value_without_haml_xss |
|
|
U
|
Haml::SafeErubisTemplate#precompiled_postamble |
|
|
U
|
Haml::Filters::SassRailsTemplate#sass_options |
|
|
U
|
Haml::SafeErubisTemplate#precompiled_preamble |
|
|
U
|
Haml::Compiler#precompiled_with_return_value |
|
|
U
|
Haml::SafeErubisTemplate#initialize_engine |
|
|
U
|
Haml::Filters::ScssRailsTemplate#syntax |
|
|
U
|
Haml::Helpers::ErrorReturn#initialize |
|
|
U
|
ActionView::Helpers::CaptureHelper |
|
|
U
|
ActionView::Helpers::FormTagHelper |
|
|
U
|
Haml::Util#unescape_interpolation |
|
|
U
|
ActionView::Helpers::HamlSupport |
|
|
U
|
Haml::Options#remove_whitespace= |
|
|
U
|
Haml::SafeErubisTemplate#prepare |
|
|
U
|
ActionView::Helpers::InstanceTag |
|
|
U
|
Haml::Engine#options_for_buffer |
|
|
U
|
ActionView::Helpers::FormHelper |
|
|
U
|
ActionView::Helpers::TextHelper |
|
|
U
|
ActionView::Helpers::TagHelper |
|
|
U
|
Haml::Filters::Erb.precompiled |
|
|
U
|
Haml::ErubisTemplateHandler |
|
|
U
|
Haml::Plugin#cache_fragment |
|
|
U
|
Haml::Options#attr_wrapper= |
|
|
U
|
Haml::Parser#compute_tabs |
|
|
U
|
Haml::Compiler#initialize |
|
|
U
|
Haml::SafeErubisTemplate |
|
|
U
|
Haml::Compiler#options= |
|
|
U
|
Haml::Options#encoding= |
|
|
U
|
Haml::Parser#initialize |
|
|
U
|
Haml::Compiler#compile |
|
|
U
|
Haml::Engine#compiler= |
|
|
U
|
Haml::Compiler#options |
|
|
U
|
Haml::Options#format= |
|
|
U
|
Haml::Engine#compiler |
|
|
U
|
Haml::Plugin#compile |
|
|
U
|
Haml::Engine#parser= |
|
|
U
|
Haml::Engine#parser |
|
|
U
|
Haml::Parser#parse |
|
|
U
|
Haml::Plugin.call |
|
|
U
|
Haml::Parser#root |
|
|
U
|
ActionView::Base |
|
|
U
|
Haml::Template |
|
|
U
|
ActionView |
|
|
U
|
Haml::Helpers::@@action_view_defined |
|
|
U
|
Haml::Exec::Generic::COLORS |
|
Let's raise the visibility of documentation in Ruby!
This page is for haml/haml 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