guard/guard Guard

Guard is a command line tool to easily handle events on f...

Refresh
#141 (all)
Ruby (change)
16 seconds
almost 6 years ago

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
Guard::Dsl#ignore! N
A
Guard N
A
Guard::Dsl#ignore N
A
Guard::Plugin::Hooker.reset_callbacks! N
A
Guard::Notifier::Base#normalize_standard_options! N
A
Guard::Notifier::Tmux#display_message N
A
Guard::Notifier::Tmux#display_title N
A
Guard::Dsl#group N
A
Guard::Notifier::Emacs#notify N
A
Guard::Plugin::Hooker#hook Ne
A
Guard::Sheller#initialize Ne
A
Guard::Dsl#callback Ne
A
Guard::Plugin::Base Ne
A
Guard::Setuper Ne
A
Guard::UI Ne
A
Guard::Dsl#scope Ne
A
Guard::Plugin::Hooker.notify Ne
A
Guard::Plugin::Base::ClassMethods#non_namespaced_classname Ne
A
Guard::Plugin::Base::ClassMethods#non_namespaced_name Ne
A
Guard::Guardfile::Evaluator#guardfile_contents Ne
A
Guard::Guardfile::Evaluator#evaluate_guardfile Ne
A
Guard::Jobs::TerminalSettings#initialize Ne
A
Guard::Notifier::TerminalNotifier Ne
A
Guard::Notifier::Base#images_path Ne
A
Guard::PluginUtil#plugin_location Ne
A
Guard::Notifier::Tmux#tmux_color Ne
A
Guard::Interactor.convert_scope Ne
A
Guard::Notifier::TerminalTitle Ne
A
Guard::PluginUtil.plugin_names Ne
A
Guard::Notifier::Base.gem_name Ne
A
Guard::Notifier::FileNotifier Ne
A
Guard::PluginUtil#initialize Ne
A
Guard::Jobs::Base#foreground Ne
A
Guard::Notifier::Base.title Ne
A
Guard::Notifier::Base#title Ne
A
Guard::Guardfile::Evaluator Ne
A
Guard::Notifier::NotifySend Ne
A
Guard::Notifier::Libnotify Ne
A
Guard::Watcher#call_action Ne
A
Guard::Notifier::Base.name Ne
A
Guard::Watcher.match_files Ne
A
Guard::Notifier::Base#name Ne
A
Guard::Options#initialize Ne
A
Guard::Watcher#initialize Ne
A
Guard::Plugin::Base#title Ne
A
Guard::Plugin::Base#name Ne
A
Guard::Plugin::Base#to_s Ne
A
Guard::Notifier::Notifu Ne
A
Guard::Notifier::Emacs Ne
A
Guard::Notifier::Growl Ne
A
Guard::Plugin::Hooker Ne
A
Guard::Sheller#stderr Ne
A
Guard::Sheller#stdout Ne
A
Guard::Notifier::Base Ne
A
Guard::Dsl#interactor Ne
A
Guard::Notifier::Tmux Ne
A
Guard::Notifier::GNTP Ne
A
Guard::Group#title Ne
A
Guard::Sheller#run Ne
A
Guard::UI.options Ne
A
Guard::Group#to_s Ne
A
Guard::PluginUtil Ne
A
Guard::Commander Ne
A
Guard::Dsl#watch Ne
A
Guard::Notifier Ne
A
Guard::CLI#init Ne
A
Guard::RakeTask Ne
A
Guard::Watcher Ne
A
Guard::Sheller Ne
A
Guard::Options Ne
A
Guard::Runner Ne
A
Guard::CLI Ne
A
Guard::Notifier#add_notifier Ne
A
Guard::Guardfile::Evaluator#reevaluate_guardfile Ne
A
Guard::Plugin::Base::ClassMethods#template Ne
A
Guard::Notifier::TerminalTitle.turn_off Ne
A
Guard::Plugin::Hooker.add_callback Ne
A
Guard::PluginUtil#add_to_guardfile Ne
A
Guard::Jobs::Base#handle_interrupt Ne
A
Guard::Plugin::Hooker.callbacks Ne
A
Guard::Notifier#clear_notifiers Ne
A
Guard::Notifier::Tmux.turn_off Ne
A
Guard::Notifier::Tmux.turn_on Ne
A
Guard::Setuper#clear_options Ne
A
Guard::UI.action_with_scopes Ne
A
Guard::Runner#run_on_changes Ne
A
Guard::Interactor#foreground Ne
A
Guard::Interactor#background Ne
A
Guard::Interactor.options= Ne
A
Guard::Interactor.enabled= Ne
A
Guard::Notifier#turn_off Ne
A
Guard::Commander#run_all Ne
A
Guard::RakeTask#options= Ne
A
Guard::RakeTask#options Ne
A
Guard::Commander#reload Ne
A
Guard::UI.reset_logger Ne
A
Guard::Notifier#toggle Ne
A
Guard::Commander#stop Ne
A
Guard::RakeTask#name= Ne
A
Guard::RakeTask#name Ne
A
Guard::UI.reset_line Ne
A
Guard::UI.clearable Ne
A
Guard::UI.logger Ne
A
Guard.scope= Ne
A
Guard::Guardfile::Generator#initialize_all_templates E
A
Guard::Guardfile::Generator#initialize_template E
A
Guard::Guardfile::Generator#create_guardfile E
A
Guard::Guardfile.initialize_all_templates E
A
Guard::Notifier::Base.require_gem_safely E
A
Guard::Plugin::Base#run_on_modifications E
A
Guard::Guardfile::Generator#initialize E
A
Guard::Guardfile::Evaluator#initialize E
A
Guard::Notifier::Base.supported_hosts E
A
Guard::Plugin::Base#run_on_additions E
A
Guard::Plugin::Base#run_on_removals E
A
Guard::PluginUtil#initialize_plugin E
A
Guard::Plugin::Base#run_on_changes E
A
Guard::Notifier::Emacs#emacs_color E
A
Guard::Setuper#evaluate_guardfile E
A
Guard::Runner.stopping_symbol_for E
A
Guard::PluginUtil#plugin_class E
A
Guard::DslDescriber#initialize E
A
Guard::DslDescriber#notifiers E
A
Guard::Setuper#reset_plugins E
A
Guard::Guardfile::Generator E
A
Guard::Setuper#reset_groups E
A
Guard::Plugin::Base#run_all E
A
Guard::RakeTask#initialize E
A
Guard::Setuper#reset_scope E
A
Guard::Plugin::Base#reload E
A
Guard::Plugin::Base#start E
A
Guard::DslDescriber#show E
A
Guard::Plugin#initialize E
A
Guard::DslDescriber#list E
A
Guard::Plugin::Base#stop E
A
Guard::Guard#initialize E
A
Guard::Group#initialize E
A
Guard::Dsl#notification E
A
Guard::Commander#start E
A
Guard::Notifier#notify E
A
Guard::UI.deprecation E
A
Guard::CLI#notifiers E
A
Guard::DslDescriber E
A
Guard::CLI#version E
A
Guard::UI.options= E
A
Guard::Dsl#logger E
A
Guard::UI.warning E
A
Guard.add_plugin E
A
Guard::Dsl#guard E
A
Guard::CLI#start E
A
Guard::CLI#show E
A
Guard::UI.error E
A
Guard::CLI#list E
A
Guard::UI.debug E
A
Guard.add_group E
A
Guard::UI.info E
A
Guard::Plugin E
A
Guard.plugins E
A
Guard.plugin E
A
Guard::Group E
A
Guard.groups E
A
Guard.group E
A
Guard::Dsl E
A
Guard::Guardfile.initialize_template E
A
Guard::Guardfile.create_guardfile E
A
Guard::Setuper#setup_scope E
A
Guard::Notifier::TerminalNotifier.supported_hosts E
A
Guard::Notifier::NotifySend.supported_hosts E
A
Guard::Notifier::TerminalNotifier.gem_name E
A
Guard::Notifier::Libnotify.supported_hosts E
A
Guard::Reevaluator#run_on_modifications E
A
Guard::Notifier::Notifu.supported_hosts E
A
Guard::Notifier::Growl.supported_hosts E
A
Guard::Notifier::GNTP.supported_hosts E
A
Guard::Jobs::PryWrapper#foreground E
A
Guard::Notifier::Notifu.gem_name E
A
Guard::Notifier::GNTP.gem_name E
A
Guard::Jobs::Sleep#foreground E
A
Guard::Notifier::Tmux#notify E
A
Guard::Interactor.enabled? E
A
Guard::Jobs::PryWrapper#handle_interrupt E
A
Guard::Jobs::Sleep#handle_interrupt E

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

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