# Inch CI

haml/haml Haml

HTML Abstraction Markup Language - A Markup Haiku

Refresh
#47 (all)
Ruby (change)
12 seconds
10 months ago
Build History Evaluation Suggestions 20+   Read the docs

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.

Seems really good
A
Haml::Helpers#haml_tag N
A
Haml::Engine#render N
A
Haml N
A
Haml::Buffer#rstrip! N
A
Haml::Helpers::ActionViewExtensions#page_class N
A
Haml::Helpers#find_and_preserve N
A
Haml::Exec::Generic#parse! N
A
Haml::Helpers#preserve N
A
Haml::Util#balance N
A
Haml::Options N
A
Haml::Helpers#capture_haml Ne
A
Haml::Engine#render_proc Ne
A
Haml::Buffer.merge_attrs Ne
A
Haml::Engine#def_method Ne
A
Haml::Helpers Ne
A
Haml::Buffer Ne
A
Haml::Helpers#haml_tag_if Ne
A
Haml::Helpers::ActionViewExtensions Ne
A
Haml::Helpers::ErrorReturn#inspect Ne
A
Haml::Filters::ScssRailsTemplate Ne
A
Haml::Options.buffer_option_keys Ne
A
Haml::Filters::SassRailsTemplate Ne
A
Haml::Helpers#init_haml_helpers Ne
A
Haml::Util#check_haml_encoding Ne
A
Haml::Buffer#capture_position Ne
A
Haml::Util#human_indentation Ne
A
Haml::Options.valid_formats Ne
A
Haml::Compiler#precompiled Ne
A
Haml::Helpers::ErrorReturn Ne
A
Haml::Helpers#html_escape Ne
A
Haml::Helpers#escape_once Ne
A
Haml::Helpers#haml_indent Ne
A
Haml::Filters::Javascript Ne
A
Haml::Helpers#html_attrs Ne
A
Haml::Exec::Generic#to_s Ne
A
Haml::Options#for_buffer Ne
A
Haml::Buffer#tabulation= Ne
A
Haml::Engine#indentation Ne
A
Haml::Helpers#with_tabs Ne
A
Haml::Buffer#tabulation Ne
A
Haml::Options.defaults Ne
A
Haml::Template#options Ne
A
Haml::Filters::Escaped Ne
A
Haml::Util#inspect_obj Ne
A
Haml::Helpers#tab_down Ne
A
Haml::Helpers#surround Ne
A
Haml::Helpers#succeed Ne
A
Haml::Filters#defined Ne
A
Haml::Helpers#precede Ne
A
Haml::Helpers#list_of Ne
A
Haml::Engine#options= Ne
A
Haml::Filters::Cdata Ne
A
Haml::Helpers#tab_up Ne
A
Haml::Filters::Plain Ne
A
Haml::Util#html_safe Ne
A
Haml::Engine#options Ne
A
Haml::Filters::Base Ne
A
Haml::Exec::Generic Ne
A
Haml::Filters::Ruby Ne
A
Haml::Buffer#buffer Ne
A
Haml::Filters::Css Ne
A
Haml::Filters::Erb Ne
A
Haml::Buffer#upper Ne
A
Haml::Error#line Ne
A
Haml::Exec::Haml Ne
A
Haml::Filters Ne
A
Haml::Engine Ne
A
Haml::Error Ne
A
Haml::Util Ne
A
Haml::Options#hyphenate_data_attrs Ne
A
Haml::Options#remove_whitespace Ne
A
Haml::Filters::Base.included Ne
A
Haml::Options#compiler_class Ne
A
Haml::Options#suppress_eval Ne
A
Haml::Options#attr_wrapper Ne
A
Haml::Options#parser_class Ne
A
Haml::Options#escape_attrs Ne
A
Haml::Options#escape_html Ne
A
Haml::Helpers#haml_concat Ne
A
Haml::Exec::Generic#puts Ne
A
Haml::Buffer#adjust_tabs Ne
A
Haml::Options#mime_type Ne
A
Haml::Options#autoclose Ne
A
Haml::Buffer#push_text Ne
A
Haml::Options#filename Ne
A
Haml::Options#encoding Ne
A
Haml::Options#preserve Ne
A
Haml::Options#format Ne
A
Haml::Options#trace Ne
A
Haml::Options#cdata Ne
A
Haml::Options#line Ne
A
Haml::Options#ugly Ne
A
Haml::Filters#remove_filter Ne
A
Haml::Helpers::ActionViewExtensions#with_raw_haml_concat E
A
Haml::Filters::Base#render_with_options E
A
Haml::Filters#register_tilt_filter E
A
Haml::Util#handle_interpolation E
A
Haml::Helpers::ErrorReturn#to_s E
A
Haml::Exec::Generic#get_line E
A
Haml::Filters::Base#compile E
A
Haml::Util#silence_warnings E
A
Haml::Filters::Base#render E
A
Haml::Exec::Generic#color E
A
Haml::Exec::Generic#parse E
A
Haml::Util#check_encoding E
A
Haml::Filters::Preserve E
A
Haml::Engine#initialize E
A
Haml::Helpers#non_haml E
A
Haml::Buffer#options E
A
Haml::Exec::Generic#process_result E
A
Haml::Exec::Generic#set_opts E
A
Haml::Buffer#options= E
A
Haml::Helpers#haml_internal_concat E
A
Haml::Exec::Haml#process_result E
A
Haml::Exec::Haml#set_opts E
Proper documentation present
B
Haml::Buffer#format_script N
B
Haml::Filters::Base#internal_compile Ne
B
Haml::Options#[]= Ne
B
Haml::Options#[] Ne
B
Haml::Buffer#capture_position= Ne
Show 26 more ...
Please take a look
C
Haml::Buffer#active= E
Undocumented
U
ActionView::Helpers::CaptureHelper#with_output_buffer_with_haml_xss N
U
ActionView::Helpers::FormTagHelper#form_tag_with_haml_xss N
U
ActionView::Helpers::FormHelper#form_for_with_haml_xss N
U
Haml::Compiler#precompiled_method_return_value_with_haml_xss N
U
ActionView::Helpers::TextHelper#safe_concat_with_haml_xss N
Show 48 more ...
Everything Inch CI

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

This page is for haml/haml 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.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.

Sign in with GitHub | Contact | Imprint | Blog