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

plataformatec/simple_form

Forms made easy for Rails! It's tied to a simple DSL, with no opinion on markup. – Read the documentation

This page shows an evaluation of the documentation of plataformatec/simple_form.

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
SimpleForm::ActionViewExtensions::FormHelper
A
SimpleForm::ActionViewExtensions::Builder
A
SimpleForm::Inputs::BlockInput#initialize
A
SimpleForm::FormBuilder#button_button
A
SimpleForm::Components::Placeholders
Show 14 more ...
A
SimpleForm::Inputs::Base#initialize
A
SimpleForm::Components::Maxlength
A
SimpleForm::Components::Readonly
A
SimpleForm::Components::Pattern
A
SimpleForm::Wrappers::Builder
A
SimpleForm::Components::Hints
A
SimpleForm::Wrappers::Single
A
SimpleForm::Wrappers::Root
A
SimpleForm::Wrappers::Many
A
SimpleForm::I18nCache
A
SimpleForm::Inputs::CollectionInput.boolean_collection
A
SimpleForm.default_input_size=
A
SimpleForm#default_wrapper
A
SimpleForm.setup
Proper documentation present
B
SimpleForm::FormBuilder#collection_radio_buttons
B
SimpleForm::FormBuilder#collection_check_boxes
B
SimpleForm::FormBuilder#input
B
SimpleForm:: #simple_fields_for
B
SimpleForm.wrappers
Show 10 more ...
B
SimpleForm::FormBuilder#association
B
SimpleForm::FormBuilder#label
B
SimpleForm::FormBuilder#error_notification
B
SimpleForm::FormBuilder#input_field
B
SimpleForm::FormBuilder#error
B
SimpleForm::FormBuilder#hint
B
SimpleForm::FormBuilder#full_error
B
SimpleForm.wrapper
B
SimpleForm.build
B
SimpleForm::Wrappers::Root#find
Needs work
Undocumented
U
SimpleForm
U
SimpleForm:: #simple_fields_for
U
SimpleForm.eager_load!
U
SimpleForm:: #apply_default_collection_options!
U
SimpleForm::FormBuilder#button
Show 174 more ...
U
SimpleForm::Inputs::Base
U
SimpleForm:: #simple_form_for
U
SimpleForm::Wrappers::Builder#optional
U
SimpleForm::Inputs::Base.disable
U
SimpleForm::Inputs::Base.enable
U
SimpleForm::MapType#map_type
U
SimpleForm::FormBuilder
U
SimpleForm:: #copy_scaffold_template
U
SimpleForm::Generators::InstallGenerator#info_bootstrap
U
SimpleForm::Components::Placeholders#placeholder_text
U
SimpleForm::Generators::InstallGenerator#copy_config
U
SimpleForm::Generators::InstallGenerator#show_readme
U
SimpleForm::Components::Labels#label_html_options
U
SimpleForm::Inputs::PriorityInput#input_priority
U
SimpleForm::Inputs::GroupedCollectionSelectInput
U
SimpleForm::Components::Placeholders#placeholder
U
SimpleForm::Tags::CollectionRadioButtons#render
U
SimpleForm::Inputs::CollectionRadioButtonsInput
U
SimpleForm::Components::LabelInput#label_input
U
SimpleForm::Inputs::CollectionCheckBoxesInput
U
SimpleForm::Tags::CollectionCheckBoxes#render
U
SimpleForm::Components::Maxlength#maxlength
U
SimpleForm::Components::Labels#label_target
U
SimpleForm::Inputs::Base#input_html_options
U
SimpleForm::Inputs::Base#input_html_classes
U
SimpleForm::Inputs::Base#additional_classes
U
SimpleForm::Components::Labels#label_text
U
SimpleForm::Inputs::CollectionSelectInput
U
SimpleForm::Components::Errors#full_error
U
SimpleForm::Components::Readonly#readonly
U
SimpleForm::Components::HTML5#initialize
U
SimpleForm::ErrorNotification#initialize
U
SimpleForm::Tags::CollectionRadioButtons
U
SimpleForm::Wrappers::Builder#initialize
U
SimpleForm::Generators::InstallGenerator
U
SimpleForm::FormBuilder.discovery_cache
U
SimpleForm::Components::Pattern#pattern
U
SimpleForm::Inputs::Base#attribute_name
U
SimpleForm::Components::MinMax#min_max
U
SimpleForm::I18nCache#reset_i18n_cache
U
SimpleForm::Tags::CollectionCheckBoxes
U
SimpleForm::Inputs::Base#input_options
U
SimpleForm::Tags::CollectionExtensions
U
SimpleForm::Wrappers::Many#initialize
U
SimpleForm::Wrappers::Leaf#initialize
U
SimpleForm::Wrappers::Many#components
U
SimpleForm::Inputs::Base#html_classes
U
SimpleForm::Wrappers::Builder#wrapper
U
SimpleForm::Wrappers::Many#namespace
U
SimpleForm::Components::Labels#label
U
SimpleForm::ErrorNotification#render
U
SimpleForm::I18nCache#get_i18n_cache
U
SimpleForm::Wrappers::Leaf#namespace
U
SimpleForm::Inputs::Base#input_class
U
SimpleForm::Components::Errors#error
U
SimpleForm::Inputs::Base#reflection
U
SimpleForm::Inputs::CollectionInput
U
SimpleForm::FormBuilder#object_name
U
SimpleForm::Components::HTML5#html5
U
SimpleForm::Wrappers::Many#defaults
U
SimpleForm::Inputs::Base#input_type
U
SimpleForm::Wrappers::Root#options
U
SimpleForm::Components::LabelInput
U
SimpleForm::Components::Hints#hint
U
SimpleForm::Wrappers::Builder#to_a
U
SimpleForm::Inputs::PasswordInput
U
SimpleForm::Wrappers::Builder#use
U
SimpleForm::Inputs::PriorityInput
U
SimpleForm::Wrappers::Many#render
U
SimpleForm.additional_classes_for
U
SimpleForm::Wrappers::Leaf#render
U
SimpleForm::Inputs::DateTimeInput
U
SimpleForm::Inputs::Base#options
U
SimpleForm::FormBuilder#template
U
SimpleForm::Inputs::BooleanInput
U
SimpleForm::Inputs::NumericInput
U
SimpleForm::I18nCache#i18n_cache
U
SimpleForm::FormBuilder#wrapper
U
SimpleForm::Inputs::StringInput
U
SimpleForm::Wrappers::Many#find
U
SimpleForm::Inputs::HiddenInput
U
SimpleForm::Wrappers::Leaf#find
U
SimpleForm::Helpers::Validators
U
SimpleForm::Inputs::Base#column
U
SimpleForm::Helpers::Autofocus
U
SimpleForm::Components::MinMax
U
SimpleForm::FormBuilder#object
U
SimpleForm::Components::Errors
U
SimpleForm::Inputs::Base#input
U
SimpleForm::Components::Labels
U
SimpleForm::Inputs::BlockInput
U
SimpleForm::Inputs::RangeInput
U
SimpleForm::ErrorNotification
U
SimpleForm::Inputs::FileInput
U
SimpleForm::Components::HTML5
U
SimpleForm::Inputs::TextInput
U
SimpleForm::Helpers::Required
U
SimpleForm::Helpers::Readonly
U
SimpleForm::Helpers::Disabled
U
SimpleForm::Wrappers::Leaf
U
SimpleForm::MapType
U
SimpleForm:: #collection_block_for_nested_boolean_style
U
SimpleForm:: #build_nested_boolean_style_item_tag
U
SimpleForm:: #item_wrapper_class
U
SimpleForm:: #translate_error_notification
U
SimpleForm:: #full_errors_on_association
U
SimpleForm::Components::Errors#full_errors_on_attribute
U
SimpleForm::ErrorNotification#error_notification_tag
U
SimpleForm::Components::Errors#errors_on_association
U
SimpleForm::Components::Errors#errors_on_attribute
U
SimpleForm::Components::Errors#full_error_text
U
SimpleForm::Components::Errors#error_method
U
SimpleForm::ErrorNotification#error_message
U
SimpleForm::ErrorNotification#html_options
U
SimpleForm::Components::Errors#full_errors
U
SimpleForm::Components::Errors#error_text
U
SimpleForm::Components::Errors#errors
U
SimpleForm::Wrappers::Root#initialize
U
SimpleForm::ErrorNotification#errors
U
SimpleForm:: #input_options
U
SimpleForm::Inputs::GroupedCollectionSelectInput#input
U
SimpleForm::Inputs::CollectionRadioButtonsInput#input
U
SimpleForm::Inputs::CollectionInput#input_options
U
SimpleForm::@@include_default_input_wrapper_class
U
SimpleForm::Inputs::CollectionSelectInput#input
U
SimpleForm::@@generate_additional_classes_for
U
SimpleForm::Inputs::BooleanInput#label_input
U
SimpleForm::Inputs::CollectionInput#input
U
SimpleForm::Inputs::PriorityInput#input
U
SimpleForm::Inputs::DateTimeInput#input
U
SimpleForm::Inputs::PasswordInput#input
U
SimpleForm::Wrappers::Single#initialize
U
SimpleForm::@@collection_wrapper_class
U
SimpleForm::@@collection_label_methods
U
SimpleForm::@@error_notification_class
U
SimpleForm::@@collection_value_methods
U
SimpleForm::Inputs::NumericInput#input
U
SimpleForm::Inputs::BooleanInput#input
U
SimpleForm::Inputs::StringInput#input
U
SimpleForm::Inputs::HiddenInput#input
U
SimpleForm::Inputs::RangeInput#input
U
SimpleForm::@@collection_wrapper_tag
U
SimpleForm::Inputs::BlockInput#input
U
SimpleForm::@@error_notification_tag
U
SimpleForm::Inputs::FileInput#input
U
SimpleForm::Wrappers::Single#render
U
SimpleForm::Inputs::TextInput#input
U
SimpleForm::@@required_by_default
U
SimpleForm::Wrappers::Root#render
U
SimpleForm::@@boolean_label_class
U
SimpleForm::@@browser_validations
U
SimpleForm::@@default_input_size
U
SimpleForm::@@item_wrapper_class
U
SimpleForm::@@time_zone_priority
U
SimpleForm::@@field_error_proc
U
SimpleForm::@@translate_labels
U
SimpleForm::@@wrapper_mappings
U
SimpleForm::@@item_wrapper_tag
U
SimpleForm::@@country_priority
U
SimpleForm::@@inputs_discovery
U
SimpleForm::@@default_wrapper
U
SimpleForm::@@cache_discovery
U
SimpleForm::@@input_mappings
U
SimpleForm::@@boolean_style
U
SimpleForm::@@file_methods
U
SimpleForm::@@button_class
U
SimpleForm::@@error_method
U
SimpleForm::@@input_class
U
SimpleForm::@@label_class
U
SimpleForm::@@i18n_scope
U
SimpleForm::@@form_class
U
SimpleForm::@@configured
U
SimpleForm::@@label_text
U
SimpleForm::@@wrappers

Let's raise the visibility of documentation in Ruby!

This page is for plataformatec/simple_form 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