Let's raise the visibility of code documentation in Ruby! What is this about?

justinfrench/formtastic

A Rails form builder plugin with semantically rich and accessible markup. – Read the documentation

This page shows an evaluation of the documentation of justinfrench/formtastic.

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
Formtastic::Helpers::FormHelper#semantic_form_for
A
Formtastic::FormBuilder#semantic_fields_for
A
Formtastic::Helpers::ActionsHelper#actions
A
Formtastic::Helpers::InputsHelper#inputs
A
Formtastic::Helpers::ActionsHelper
Show 57 more ...
A
Formtastic::Inputs::Base::Timeish
A
Formtastic::Helpers::FormHelper
A
Formtastic::InstallGenerator
A
Formtastic::FormGenerator
A
Formtastic::Localizer
A
Formtastic
A
Formtastic:: #requirement_text_or_proc
A
Formtastic::Inputs::Base::Stringish#input_html_options
A
Formtastic::Inputs::Base::Validations#validation_min
A
Formtastic::Inputs::Base::Choices#label_html_options
A
Formtastic::Inputs::Base::Validations#validation_max
A
Formtastic::Inputs::Base::Associations#association
A
Formtastic::Helpers::InputHelper#input_class
A
Formtastic::Helpers::ActionHelper#action
A
Formtastic::Inputs::DatetimePickerInput
A
Formtastic::Inputs::Base::Html#to_html
A
Formtastic::Helpers::InputHelper#input
A
Formtastic::Inputs::TimePickerInput
A
Formtastic::Inputs::DatePickerInput
A
Formtastic::Inputs::TimeSelectInput
A
Formtastic::Inputs::CheckBoxesInput
A
Formtastic::Inputs::DateSelectInput
A
Formtastic::Helpers::InputsHelper
A
Formtastic::Inputs::TimeZoneInput
A
Formtastic::Inputs::PasswordInput
A
Formtastic::Inputs::BooleanInput
A
Formtastic::Helpers::InputHelper
A
Formtastic::Inputs::CountryInput
A
Formtastic::Inputs::SelectInput
A
Formtastic::Inputs::SearchInput
A
Formtastic::Inputs::HiddenInput
A
Formtastic::Inputs::NumberInput
A
Formtastic::Inputs::PhoneInput
A
Formtastic::Inputs::EmailInput
A
Formtastic::Inputs::RangeInput
A
Formtastic::Inputs::RadioInput
A
Formtastic::Inputs::FileInput
A
Formtastic::Inputs::TextInput
A
Formtastic::Inputs::UrlInput
A
Formtastic::FormGenerator#association_columns
A
Formtastic::FormGenerator#content_columns
A
Formtastic::Inputs::CheckBoxesInput#to_html
A
Formtastic::Inputs::TimeZoneInput#to_html
A
Formtastic::Inputs::CountryInput#to_html
A
Formtastic::Inputs::BooleanInput#to_html
A
Formtastic::Inputs::NumberInput#to_html
A
Formtastic::Inputs::SelectInput#to_html
A
Formtastic::Inputs::HiddenInput#to_html
A
Formtastic::Inputs::RadioInput#to_html
A
Formtastic::Inputs::RangeInput#to_html
A
Formtastic::Inputs::TextInput#to_html
A
Formtastic::Inputs::FileInput#to_html
A
Formtastic::Inputs::DateSelectInput#time_fragments
A
Formtastic::Inputs::RadioInput#label_html_options
A
Formtastic::Inputs::TimeSelectInput#fragments
A
Formtastic::Actions::ButtonAction#to_html
A
Formtastic::Actions::LinkAction#to_html
Proper documentation present
B
Formtastic::Inputs::Base#warn_and_correct_option!
B
Formtastic::Inputs::Base#warn_deprecated_option!
B
Formtastic::Inputs::Base#removed_option!
B
Formtastic::Helpers::FormHelper#semantic_fields_for
B
Formtastic::Helpers::ErrorsHelper#semantic_errors
Show 8 more ...
B
Formtastic::Inputs::Base::Wrapping#input_wrapping
B
Formtastic:: #input_class_with_const_defined
B
Formtastic:: #standard_action_class_name
B
Formtastic:: #send_or_call_or_object
B
Formtastic:: #custom_action_class_name
B
Formtastic:: #standard_input_class_name
B
Formtastic:: #custom_input_class_name
B
Formtastic::Helpers::InputHelper#input_class_by_trying
Needs work
C
Formtastic::Inputs::Base::Stringish#to_html
C
Formtastic::Inputs::Base::Wrapping
C
Formtastic::Inputs::PasswordInput#to_html
C
Formtastic::Inputs::SearchInput#to_html
C
Formtastic::Inputs::PhoneInput#to_html
Show 2 more ...
C
Formtastic::Inputs::EmailInput#to_html
C
Formtastic::Inputs::UrlInput#to_html
Undocumented
U
Formtastic:: #not_required_through_negated_validation!
U
Formtastic::Localizer::Cache#clear!
U
Formtastic::Actions::Base#check_supported_methods!
U
Formtastic::Actions::Base#initialize
U
Formtastic::Inputs::Base#initialize
Show 289 more ...
U
Formtastic::FormBuilder#initialize
U
Formtastic::Actions::Base
U
Formtastic::Inputs::Base
U
Formtastic:: #fragments_inner_wrapping
U
Formtastic:: #choices_group_wrapping
U
Formtastic::Inputs::Base::Timeish#fragments_wrapping
U
Formtastic::Inputs::Base::Timeish#fragment_wrapping
U
Formtastic::Inputs::Base::Choices#choices_wrapping
U
Formtastic::Inputs::Base::Choices#choice_wrapping
U
Formtastic::Actions::Base#wrapper
U
Formtastic:: #group_label_method_from_grouped_collection
U
Formtastic:: #message
U
Formtastic:: #message
U
Formtastic:: #group_association_from_reflection
U
Formtastic:: #group_label_method_from_options
U
Formtastic:: #label_and_value_method_from_collection
U
Formtastic:: #group_association_from_options
U
Formtastic:: ::IndeterminableMinimumAttributeError
U
Formtastic:: ::IndeterminableMaximumAttributeError
U
Formtastic:: #choices_group_wrapping_html_options
U
Formtastic:: #extra_input_html_options
U
Formtastic:: #raw_grouped_collection
U
Formtastic:: #check_box_without_hidden_input
U
Formtastic:: #label_text_with_embedded_checkbox
U
Formtastic:: #collection_from_association
U
Formtastic:: #fragments_wrapping_html_options
U
Formtastic:: #fragment_wrapping_html_options
U
Formtastic:: #input_html_options_name_multiple
U
Formtastic:: #group_label_method
U
Formtastic:: #label_method_from_options
U
Formtastic:: #grouped_collection
U
Formtastic:: #check_box_with_hidden_input
U
Formtastic:: #choices_wrapping_html_options
U
Formtastic:: #value_method_from_options
U
Formtastic:: #association_primary_key
U
Formtastic:: #choice_wrapping_html_options
U
Formtastic:: #group_association
U
Formtastic:: #collection_from_options
U
Formtastic:: #default_maxlength
U
Formtastic:: #default_choice_html_options
U
Formtastic:: #collection_for_boolean
U
Formtastic:: #custom_choice_html_options
U
Formtastic:: #label_and_value_method
U
Formtastic:: #with_custom_field_error_proc
U
Formtastic:: #wrapper_html_options_from_options
U
Formtastic:: #html_input_type
U
Formtastic:: #wrapper_html_options_raw
U
Formtastic:: #label_with_nested_checkbox
U
Formtastic:: #value_or_default_value
U
Formtastic:: #attributized_method_name
U
Formtastic:: #hidden_date_fragments
U
Formtastic:: #default_step
U
Formtastic:: #input_html_options
U
Formtastic:: #default_date_fragments
U
Formtastic:: #extra_button_html_options
U
Formtastic:: #input_html_options_name
U
Formtastic:: #default_size
U
Formtastic:: #hidden_field_for_all
U
Formtastic:: #extra_input_html_options
U
Formtastic:: #choice_html_safe_value
U
Formtastic:: #wrapper_html_options
U
Formtastic::Inputs::Base::Wrapping#wrapper_html_options
U
Formtastic::Inputs::SelectInput#input_html_options_name
U
Formtastic::Inputs::Base::Naming#sanitized_object_name
U
Formtastic::Inputs::CheckBoxesInput#extra_html_options
U
Formtastic::Inputs::Base::Labelling#label_from_options
U
Formtastic::Inputs::Base::Validations#validation_limit
U
Formtastic::Actions::Base#default_wrapper_html_options
U
Formtastic::Actions::Base#wrapper_classes_from_options
U
Formtastic::Inputs::Base::Numeric#wrapper_html_options
U
Formtastic::Inputs::Base::Naming#sanitized_method_name
U
Formtastic::Inputs::Base::Naming#humanized_method_name
U
Formtastic::Inputs::Base::Placeholder#placeholder_text
U
Formtastic::Inputs::Base::Hints#hint_text_from_options
U
Formtastic::Inputs::Base::Wrapping#wrapper_classes_raw
U
Formtastic::Inputs::Base::Labelling#label_html_options
U
Formtastic::Inputs::Base::DatetimePickerish#maxlength
U
Formtastic::Inputs::Base::Validations#validation_step
U
Formtastic::Inputs::Base::Timeish#fragment_input_html
U
Formtastic::Inputs::Base::Timeish#fragment_label_html
U
Formtastic::Inputs::Base::Choices#choice_html_options
U
Formtastic::Inputs::Base::GroupedCollections#group_by
U
Formtastic::Inputs::Base::Timeish#i18n_date_fragments
U
Formtastic::Inputs::Base::Choices#choice_input_dom_id
U
Formtastic::Inputs::Base::Labelling#requirement_text
U
Formtastic::Inputs::Base::Collections#raw_collection
U
Formtastic::Inputs::Base::Errors#error_sentence_html
U
Formtastic::Inputs::Base::Options#formtastic_options
U
Formtastic::Inputs::Base::Numeric#input_html_options
U
Formtastic::InstallGenerator#copy_scaffold_template
U
Formtastic::Inputs::CheckBoxesInput#selected_values
U
Formtastic::Inputs::Base::Timeish#hidden_field_name
U
Formtastic::Actions::Base#extra_button_html_options
U
Formtastic::Inputs::CheckBoxesInput#unchecked_value
U
Formtastic::Inputs::CheckBoxesInput#disabled_values
U
Formtastic::Inputs::Base::Labelling#localized_label
U
Formtastic::Inputs::SelectInput#grouped_select_html
U
Formtastic::Inputs::CountryInput#priority_countries
U
Formtastic::Inputs::DateSelectInput#fragment_value
U
Formtastic::Inputs::Base::Collections#value_method
U
Formtastic::Inputs::Base::Collections#send_or_call
U
Formtastic::Inputs::Base::Validations#column_limit
U
Formtastic::Inputs::Base::Wrapping#wrapper_classes
U
Formtastic::Inputs::TimeSelectInput#fragment_value
U
Formtastic::Inputs::Base::Collections#label_method
U
Formtastic::Inputs::Base::Timeish#hidden_fragments
U
Formtastic::Inputs::BooleanInput#hidden_field_html
U
Formtastic::Actions::Base#button_html_from_options
U
Formtastic::Inputs::Base::Associations#reflection
U
Formtastic::Inputs::Base::Wrapping#wrapper_dom_id
U
Formtastic::Inputs::Base::Errors#error_first_html
U
Formtastic::Inputs::Base::Html#input_html_options
U
Formtastic::Inputs::Base::DatetimePickerish#value
U
Formtastic::Inputs::Base::Timeish#fragments_label
U
Formtastic::Actions::Base#wrapper_id_from_options
U
Formtastic::Inputs::Base::Validations#validations
U
Formtastic::Actions::Base#default_wrapper_classes
U
Formtastic::Inputs::Base::Timeish#fragment_prefix
U
Formtastic::Inputs::Base::DatetimePickerish#step
U
Formtastic::Inputs::TimeZoneInput#priority_zones
U
Formtastic::Actions::Buttonish#supported_methods
U
Formtastic::Inputs::BooleanInput#unchecked_value
U
Formtastic::Inputs::Base::Errors#error_list_html
U
Formtastic::Inputs::Base::Timeish#fragment_label
U
Formtastic::Inputs::Base::DatetimePickerish#size
U
Formtastic::Inputs::Base::Timeish#time_fragments
U
Formtastic::Inputs::Base::Errors#error_none_html
U
Formtastic::Inputs::Base::Collections#collection
U
Formtastic::Inputs::Base::Timeish#date_fragments
U
Formtastic::Inputs::BooleanInput#check_box_html
U
Formtastic::Inputs::Base::Timeish#fragment_name
U
Formtastic::Inputs::Base::Options#input_options
U
Formtastic::Inputs::Base::Choices#choice_value
U
Formtastic::Inputs::Base::Choices#choice_label
U
Formtastic::Inputs::BooleanInput#checked_value
U
Formtastic::Actions::Base#wrapper_html_options
U
Formtastic::Inputs::Base::Labelling#label_html
U
Formtastic::Helpers::ActionHelper#action_class
U
Formtastic::Inputs::Base::Labelling#label_text
U
Formtastic::Inputs::SelectInput#include_blank
U
Formtastic::Inputs::Base::Timeish#fragment_id
U
Formtastic::Inputs::Base::Choices#choice_html
U
Formtastic::Inputs::Base::Numeric#step_option
U
Formtastic::Inputs::Base::Stringish#maxlength
U
Formtastic::Inputs::Base::Choices#legend_html
U
Formtastic::Actions::Base#default_button_html
U
Formtastic::Actions::Base#default_wrapper_id
U
Formtastic::Inputs::Base::GroupedCollections
U
Formtastic::Inputs::Base::Numeric#max_option
U
Formtastic::Inputs::Base::Numeric#min_option
U
Formtastic::Inputs::Base::Validations#limit
U
Formtastic::Inputs::Base::Errors#error_keys
U
Formtastic::Inputs::Base::Timeish#positions
U
Formtastic::Inputs::Base::Timeish#fragments
U
Formtastic::Actions::Base#supported_methods
U
Formtastic::Inputs::SelectInput#select_html
U
Formtastic::Inputs::Base::Errors#error_html
U
Formtastic::Inputs::Base::Numeric#in_option
U
Formtastic::Inputs::Base::DatetimePickerish
U
Formtastic::Inputs::Base::Naming#input_name
U
Formtastic::Inputs::Base::Timeish#position
U
Formtastic::Inputs::Base::Hints#hint_html
U
Formtastic::Inputs::Base::Database#column
U
Formtastic::Inputs::Base::Timeish#to_html
U
Formtastic::Inputs::Base::Hints#hint_text
U
Formtastic::Inputs::Base::Html#dom_index
U
Formtastic::Inputs::Base::Stringish#size
U
Formtastic::FormGenerator#create_or_show
U
Formtastic::Inputs::Base::Timeish#value
U
Formtastic::Actions::Base#wrapper_class
U
Formtastic::Inputs::Base::Errors#errors
U
Formtastic::InstallGenerator#copy_files
U
Formtastic::Inputs::Base::Associations
U
Formtastic::LocalizedString#model_name
U
Formtastic::Actions::Base#object_name=
U
Formtastic::Actions::Base#object_name
U
Formtastic::Inputs::Base#object_name=
U
Formtastic::Inputs::Base::Placeholder
U
Formtastic::Inputs::Base::Validations
U
Formtastic::Inputs::Base::Collections
U
Formtastic::Inputs::Base::Html#dom_id
U
Formtastic::Actions::Base#button_html
U
Formtastic::Inputs::Base#object_name
U
Formtastic::Actions::Base#wrapper_id
U
Formtastic::Actions::LinkAction#url
U
Formtastic::Inputs::Base::Naming#as
U
Formtastic::Inputs::Base::Labelling
U
Formtastic::Actions::Base#accesskey
U
Formtastic::Actions::Base#template=
U
Formtastic::Inputs::Base::Stringish
U
Formtastic::Localizer::Cache#cache
U
Formtastic::Inputs::Base#template=
U
Formtastic::FormBuilder#auto_index
U
Formtastic::Actions::Base#template
U
Formtastic::Inputs::Base::Database
U
Formtastic::Actions::Base#builder=
U
Formtastic::Actions::Base#options=
U
Formtastic::Helpers::ErrorsHelper
U
Formtastic::Inputs::Base::Choices
U
Formtastic::Actions::Base#options
U
Formtastic::Actions::Base#method=
U
Formtastic::Actions::Base#object=
U
Formtastic::Inputs::Base#builder=
U
Formtastic::Inputs::Base#template
U
Formtastic::Actions::Base#to_html
U
Formtastic::Helpers::ActionHelper
U
Formtastic::Inputs::Base::Numeric
U
Formtastic::FormBuilder.configure
U
Formtastic::Actions::ButtonAction
U
Formtastic::Actions::Base#builder
U
Formtastic::Inputs::Base#options=
U
Formtastic::Inputs::Base::Fileish
U
Formtastic::Inputs::Base::Options
U
Formtastic::Inputs::Base#options
U
Formtastic::Inputs::Base#method=
U
Formtastic::Localizer::Cache#get
U
Formtastic::Localizer::Cache#set
U
Formtastic::FormBuilder#template
U
Formtastic::Actions::InputAction
U
Formtastic::Inputs::Base#object=
U
Formtastic::Localizer#initialize
U
Formtastic::Inputs::Base#builder
U
Formtastic::Actions::Base#object
U
Formtastic::Inputs::Base::Naming
U
Formtastic::Actions::Base#method
U
Formtastic::Inputs::Base::Errors
U
Formtastic::Inputs::Base#method
U
Formtastic::Actions::LinkAction
U
Formtastic::Inputs::Base::Hints
U
Formtastic::Inputs::Base#object
U
Formtastic::Actions::Base#text
U
Formtastic::Actions::Buttonish
U
Formtastic::Inputs::Base::Html
U
Formtastic::Localizer#builder=
U
Formtastic::Localizer#builder
U
Formtastic::Localizer::Cache
U
Formtastic::Localizer.cache
U
Formtastic::LocalizedString
U
Formtastic::FormBuilder
U
Formtastic:: #fieldset_contents_from_column_list
U
Formtastic:: #default_columns_for_object
U
Formtastic:: #step_from_macro
U
Formtastic:: #make_selected_values
U
Formtastic::Helpers::ActionsHelper#default_actions
U
Formtastic::Actions::Base#sanitized_object_name
U
Formtastic::FormGenerator#reflected_attributes
U
Formtastic::Localizer#i18n_lookups_by_default
U
Formtastic::Helpers::ErrorsHelper#error_keys
U
Formtastic::FormGenerator#save_to_clipboard
U
Formtastic::Localizer#normalize_model_name
U
Formtastic::Actions::Base#submit_i18n_key
U
Formtastic::FormGenerator#controller_path
U
Formtastic::Localizer#i18n_cache_lookups
U
Formtastic::Actions::Base#i18n_key
U
Formtastic::FormGenerator#model
U
Formtastic:: ::@@default_form_model_class_proc
U
Formtastic:: ::@@formtastic_field_error_proc
U
Formtastic:: #input_html_options
U
Formtastic::Inputs::DatetimePickerInput#html_input_type
U
Formtastic::Helpers::FormHelper::@@default_form_class
U
Formtastic::Inputs::TimeSelectInput#hidden_fragments
U
Formtastic::Inputs::DateSelectInput#hidden_fragments
U
Formtastic::Inputs::DatetimePickerInput#default_size
U
Formtastic::Inputs::DatePickerInput#html_input_type
U
Formtastic::Inputs::TimePickerInput#html_input_type
U
Formtastic::Inputs::BooleanInput#label_html_options
U
Formtastic::Inputs::BooleanInput#input_html_options
U
Formtastic::Inputs::SelectInput#input_html_options
U
Formtastic::Inputs::SelectInput#label_html_options
U
Formtastic::Actions::LinkAction#supported_methods
U
Formtastic::Inputs::DatePickerInput#default_size
U
Formtastic::Inputs::TimePickerInput#default_step
U
Formtastic::Inputs::TextInput#input_html_options
U
Formtastic::Inputs::TimePickerInput#default_size
U
Formtastic::Inputs::CheckBoxesInput#choice_html
U
Formtastic::Inputs::CheckBoxesInput#input_name
U
Formtastic::Inputs::DatetimePickerInput#value
U
Formtastic::Inputs::SelectInput#input_options
U
Formtastic::Inputs::NumberInput#step_option
U
Formtastic::Helpers::FormHelper::@@builder
U
Formtastic::Inputs::RadioInput#choice_html
U
Formtastic::Inputs::RangeInput#step_option
U
Formtastic::Inputs::HiddenInput#error_html
U
Formtastic::Inputs::HiddenInput#hint_html
U
Formtastic::Inputs::RangeInput#max_option
U
Formtastic::Inputs::RangeInput#min_option
U
Formtastic::Inputs::TimePickerInput#value
U
Formtastic::Inputs::DatePickerInput#value
U
Formtastic::Actions::InputAction#to_html

Let's raise the visibility of documentation in Ruby!

This page is for justinfrench/formtastic 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?

Sure!

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.

Fork me on GitHub