This page shows an evaluation of the documentation of guard/guard.
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
|
Guard::Dsl#ignore! | |
A
|
Guard | |
A
|
Guard::Dsl#ignore | |
A
|
Guard::Plugin::Hooker.reset_callbacks! | |
A
|
Guard::Notifier::Base#normalize_standard_options! | |
Show 167 more ... | ||
A
|
Guard::Notifier::Tmux#display_message | |
A
|
Guard::Notifier::Tmux#display_title | |
A
|
Guard::Dsl#group | |
A
|
Guard::Notifier::Emacs#notify | |
A
|
Guard::Plugin::Hooker#hook | |
A
|
Guard::Plugin::Base | |
A
|
Guard::Dsl#callback | |
A
|
Guard::Interactor | |
A
|
Guard::Plugin::Hooker.notify | |
A
|
Guard:: … #non_namespaced_classname | |
A
|
Guard::Plugin::Base::ClassMethods#non_namespaced_name | |
A
|
Guard::Guardfile::Evaluator#guardfile_contents | |
A
|
Guard::Guardfile::Evaluator#evaluate_guardfile | |
A
|
Guard::Notifier::TerminalNotifier | |
A
|
Guard::Notifier::Base#images_path | |
A
|
Guard::PluginUtil#plugin_location | |
A
|
Guard::Runner#run_supervised_task | |
A
|
Guard::Notifier::Tmux#tmux_color | |
A
|
Guard::Interactor.convert_scope | |
A
|
Guard::Notifier::TerminalTitle | |
A
|
Guard::PluginUtil.plugin_names | |
A
|
Guard::Notifier::Base.gem_name | |
A
|
Guard::Notifier::FileNotifier | |
A
|
Guard::PluginUtil#initialize | |
A
|
Guard::Interactor#initialize | |
A
|
Guard::Notifier::GrowlNotify | |
A
|
Guard::Notifier::NotifySend | |
A
|
Guard::Guardfile::Evaluator | |
A
|
Guard::Notifier::Base.title | |
A
|
Guard::Notifier::Base#title | |
A
|
Guard::Notifier::Base#name | |
A
|
Guard::Watcher#call_action | |
A
|
Guard::Watcher.match_files | |
A
|
Guard::Notifier::Libnotify | |
A
|
Guard::Notifier::Base.name | |
A
|
Guard::Options#initialize | |
A
|
Guard::Interactor.options | |
A
|
Guard::Watcher#initialize | |
A
|
Guard::Interactor.enabled | |
A
|
Guard::Plugin::Base#title | |
A
|
Guard::Plugin::Base#name | |
A
|
Guard::Plugin::Base#to_s | |
A
|
Guard::Notifier::Notifu | |
A
|
Guard::Notifier::Emacs | |
A
|
Guard::Notifier::Growl | |
A
|
Guard::Notifier::Tmux | |
A
|
Guard::Dsl#interactor | |
A
|
Guard::Plugin::Hooker | |
A
|
Guard::Notifier::GNTP | |
A
|
Guard::Notifier::Base | |
A
|
Guard::Setuper#setup | |
A
|
Guard::Watcher#match | |
A
|
Guard::Group#title | |
A
|
Guard::PluginUtil | |
A
|
Guard::Group#to_s | |
A
|
Guard::UI.options | |
A
|
Guard::Dsl#watch | |
A
|
Guard::Notifier | |
A
|
Guard::CLI#init | |
A
|
Guard::RakeTask | |
A
|
Guard::Watcher | |
A
|
Guard::Options | |
A
|
Guard::Runner | |
A
|
Guard::CLI | |
A
|
Guard::UI | |
A
|
Guard::Notifier#add_notifier | |
A
|
Guard::Guardfile::Evaluator#reevaluate_guardfile | |
A
|
Guard::Plugin::Base::ClassMethods#template | |
A
|
Guard::Notifier::TerminalTitle.turn_off | |
A
|
Guard::PluginUtil#add_to_guardfile | |
A
|
Guard::Plugin::Hooker.add_callback | |
A
|
Guard::Notifier#clear_notifiers | |
A
|
Guard::Plugin::Hooker.callbacks | |
A
|
Guard::Notifier::Tmux.turn_off | |
A
|
Guard::Notifier::Tmux.turn_on | |
A
|
Guard::Setuper#clear_options | |
A
|
Guard::Runner#run_on_changes | |
A
|
Guard::Interactor.enabled= | |
A
|
Guard::Setuper#interactor | |
A
|
Guard::RakeTask#options= | |
A
|
Guard::Setuper#evaluator | |
A
|
Guard::Commander#run_all | |
A
|
Guard::Notifier#turn_off | |
A
|
Guard::Commander#reload | |
A
|
Guard::RakeTask#options | |
A
|
Guard::Interactor#start | |
A
|
Guard::Notifier#toggle | |
A
|
Guard::Setuper#options | |
A
|
Guard::Interactor#stop | |
A
|
Guard::Commander#pause | |
A
|
Guard::Commander#stop | |
A
|
Guard::RakeTask#name= | |
A
|
Guard::UI.reset_line | |
A
|
Guard::RakeTask#name | |
A
|
Guard::UI.clearable | |
A
|
Guard::UI.logger | |
A
|
Guard::Guardfile::Generator#initialize_all_templates | |
A
|
Guard::Guardfile::Generator#initialize_template | |
A
|
Guard::Guardfile::Generator#create_guardfile | |
A
|
Guard::Notifier::Base.require_gem_safely | |
A
|
Guard::Plugin::Base#run_on_modifications | |
A
|
Guard::Guardfile::Generator#initialize | |
A
|
Guard::Guardfile::Evaluator#initialize | |
A
|
Guard::Notifier::Base.supported_hosts | |
A
|
Guard::Plugin::Base#run_on_additions | |
A
|
Guard::PluginUtil#initialize_plugin | |
A
|
Guard::Plugin::Base#run_on_removals | |
A
|
Guard::Plugin::Base#run_on_changes | |
A
|
Guard::Notifier::Emacs#emacs_color | |
A
|
Guard::Runner.stopping_symbol_for | |
A
|
Guard::Setuper#evaluate_guardfile | |
A
|
Guard::DslDescriber#initialize | |
A
|
Guard::PluginUtil#plugin_class | |
A
|
Guard::DslDescriber#notifiers | |
A
|
Guard::Setuper#reset_plugins | |
A
|
Guard::Setuper#reset_groups | |
A
|
Guard::Plugin::Base#run_all | |
A
|
Guard::Guardfile::Generator | |
A
|
Guard::Plugin::Base#reload | |
A
|
Guard::Setuper#reset_scope | |
A
|
Guard::RakeTask#initialize | |
A
|
Guard::Interactor.options= | |
A
|
Guard::Plugin::Base#start | |
A
|
Guard::DslDescriber#show | |
A
|
Guard::DslDescriber#list | |
A
|
Guard::Plugin::Base#stop | |
A
|
Guard::Plugin#initialize | |
A
|
Guard::Guard#initialize | |
A
|
Guard::Dsl#notification | |
A
|
Guard::Group#initialize | |
A
|
Guard::Commander#start | |
A
|
Guard::Notifier#notify | |
A
|
Guard::UI.deprecation | |
A
|
Guard::CLI#notifiers | |
A
|
Guard::DslDescriber | |
A
|
Guard::CLI#version | |
A
|
Guard::UI.options= | |
A
|
Guard::UI.warning | |
A
|
Guard::Dsl#logger | |
A
|
Guard.add_plugin | |
A
|
Guard::Dsl#guard | |
A
|
Guard::CLI#start | |
A
|
Guard::CLI#show | |
A
|
Guard::UI.error | |
A
|
Guard.add_group | |
A
|
Guard::CLI#list | |
A
|
Guard::UI.debug | |
A
|
Guard::UI.info | |
A
|
Guard::Plugin | |
A
|
Guard.plugins | |
A
|
Guard::Group | |
A
|
Guard.plugin | |
A
|
Guard.groups | |
A
|
Guard.group | |
A
|
Guard::Dsl | |
A
|
Guard::Setuper#setup_scope | |
A
|
Guard::Notifier::TerminalNotifier.supported_hosts | |
A
|
Guard::Notifier::GrowlNotify.supported_hosts | |
A
|
Guard::Notifier::NotifySend.supported_hosts | |
A
|
Guard::Notifier::Libnotify.supported_hosts | |
A
|
Guard::Notifier::TerminalNotifier.gem_name | |
A
|
Guard::Notifier::Notifu.supported_hosts | |
A
|
Guard::Notifier::Growl.supported_hosts | |
A
|
Guard::Notifier::GNTP.supported_hosts | |
A
|
Guard::Notifier::Notifu.gem_name | |
A
|
Guard::Notifier::GNTP.gem_name | |
A
|
Guard::Notifier::Tmux#notify |
Proper documentation present | ||
---|---|---|
B
|
Guard::Dsl#scope | |
B
|
Guard::Commander#within_preserved_state | |
B
|
Guard::Runner#run | |
B
|
Guard::Notifier::Base#notify | |
B
|
Guard::Notifier#turn_on | |
Show 2 more ... | ||
B
|
Guard::UI.clear | |
B
|
Guard::Guardfile |
Needs work | ||
---|---|---|
C
|
Guard::UI.action_with_scopes | |
C
|
Guard::DeprecatedMethods#add_guard | |
C
|
Guard::Guardfile.initialize_all_templates | |
C
|
Guard::DeprecatedMethods#get_guard_class | |
C
|
Guard::DeprecatedMethods#guard_gem_names | |
Show 6 more ... | ||
C
|
Guard::DeprecatedMethods#locate_guard | |
C
|
Guard::Guardfile.initialize_template | |
C
|
Guard::Guardfile.create_guardfile | |
C
|
Guard::DeprecatedMethods#guards | |
C
|
Guard::Dsl.evaluate_guardfile | |
C
|
Guard::Guard |
Undocumented | ||
---|---|---|
U
|
Guard::Setuper | |
U
|
Guard::Guardfile::Evaluator#guardfile_source | |
U
|
Guard::Guardfile::Evaluator#guardfile_path | |
U
|
Guard::Notifier::Tmux.options_store | |
U
|
Guard::Guardfile::Evaluator#options | |
Show 42 more ... | ||
U
|
Guard::Guardfile::Generator#options | |
U
|
Guard::Plugin::Base::ClassMethods | |
U
|
Guard::Notifier::Base#initialize | |
U
|
Guard::Plugin::Base#callbacks= | |
U
|
Guard::Plugin::Base#watchers= | |
U
|
Guard::Plugin::Base#callbacks | |
U
|
Guard::Notifier::Base#options | |
U
|
Guard::Plugin::Base#watchers | |
U
|
Guard::Plugin::Base#options= | |
U
|
Guard::Plugin::Base#options | |
U
|
Guard::DslDescriber#options | |
U
|
Guard::Notifier#notifiers= | |
U
|
Guard::Plugin::Base#group= | |
U
|
Guard::Plugin::Base#group | |
U
|
Guard::Interactor#thread= | |
U
|
Guard::Notifier#notifiers | |
U
|
Guard::Interactor#thread | |
U
|
Guard::Setuper#watchdirs | |
U
|
Guard::DeprecatedMethods | |
U
|
Guard::Watcher#pattern= | |
U
|
Guard::PluginUtil#name= | |
U
|
Guard::PluginUtil#name | |
U
|
Guard::Watcher#pattern | |
U
|
Guard::Watcher#action= | |
U
|
Guard::Group#options= | |
U
|
Guard::Watcher#action | |
U
|
Guard::Group#options | |
U
|
Guard::Group#name= | |
U
|
Guard::Group#name | |
U
|
Guard::Commander | |
U
|
Guard.listener= | |
U
|
Guard.running= | |
U
|
Guard.listener | |
U
|
Guard.running | |
U
|
Guard.runner= | |
U
|
Guard.runner | |
U
|
Guard.scope= | |
U
|
Guard.scope | |
U
|
Guard.lock= | |
U
|
Guard.lock | |
U
|
Guard::Deprecator | |
U
|
Guard::UI::Colors |
This page is for guard/guard
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)
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.