guard/guard Guard

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

Refresh
#453 (all)
Ruby (change)
13 seconds
about 3 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.

Please take a look
C
Guard::Runner#run Ne
Undocumented
U
Guard::ArubaAdapter#execute! N
U
Pathname N
U
Guard::ArubaAdapter#initialize N
U
Guard::Deprecated::Guard::ClassMethods#listener= Ne
U
Guard::Deprecated::Guard::ClassMethods#add_guard Ne
U
Guard::Deprecated::Guard::ClassMethods Ne
U
Guard::Jobs::PryWrapper Ne
U
Pathname#binwrite Ne
U
Guard::Deprecated::Guardfile::ClassMethods#initialize_all_templates Ne
U
Guard::Deprecated::Guardfile::ClassMethods#initialize_template Ne
U
Guard::Deprecated::Guardfile::ClassMethods#create_guardfile Ne
U
Guard::Watcher::Pattern::DeprecatedRegexp.show_deprecation Ne
U
Guard::Deprecated::Guard::ClassMethods#evaluate_guardfile Ne
U
Guard::Deprecated::Dsl::ClassMethods#evaluate_guardfile Ne
U
Guard::Deprecated::Guard::ClassMethods#get_guard_class Ne
U
Guard::Deprecated::Guard::ClassMethods#reset_evaluator Ne
U
Guard::Deprecated::Guard::ClassMethods#guard_gem_names Ne
U
Guard::Guardfile::Generator::NoSuchPlugin#plugin_name Ne
U
Guard::Guardfile::Generator::NoSuchPlugin#class_name Ne
U
Guard::Watcher::Pattern::DeprecatedRegexp#initialize Ne
U
Guard::Cli::Environments::Valid#initialize_guardfile Ne
U
Guard::Guardfile::Generator::NoSuchPlugin#initialize Ne
U
Guard::Deprecated::Guard::ClassMethods#locate_guard Ne
U
Guard::Guardfile::Generator::NoSuchPlugin#message Ne
U
Guard::Watcher::Pattern::DeprecatedRegexp.convert Ne
U
Guard::Deprecated::Guard::ClassMethods#add_plugin Ne
U
Guard::Cli::Environments::EvaluateOnly#initialize Ne
U
Guard::Deprecated::Evaluator#reevaluate_guardfile Ne
U
Guard::Deprecated::Guard::ClassMethods#evaluator Ne
U
Guard::Deprecated::Guard::ClassMethods#add_group Ne
U
Guard::Deprecated::Evaluator#evaluate_guardfile Ne
U
Guard::Watcher::Pattern::MatchResult#initialize Ne
U
Guard::Cli::Environments::EvaluateOnly#evaluate Ne
U
Guard::Deprecated::Guard::ClassMethods#options Ne
U
Guard::Deprecated::Guard::ClassMethods#running Ne
U
Guard::Watcher::Pattern::SimplePath#initialize Ne
U
Guard::Deprecated::Guard::ClassMethods#plugins Ne
U
Guard::Deprecated::Guard::ClassMethods#groups Ne
U
Guard::Deprecated::Guard::ClassMethods#plugin Ne
U
Guard::Deprecated::Guard::ClassMethods#guards Ne
U
Guard::Deprecated::Guard::ClassMethods#scope= Ne
U
Guard::Deprecated::Guard::ClassMethods#runner Ne
U
Guard::Guardfile::Evaluator#guardfile_source Ne
U
Guard::Deprecated::Guard::ClassMethods#group Ne
U
Guard::Deprecated::Guard::ClassMethods#scope Ne
U
Guard::Deprecated::Evaluator.add_deprecated Ne
U
Guard::Watcher::Pattern::Matcher#initialize Ne
U
Guard::Deprecated::Guardfile.add_deprecated Ne
U
Guard::Cli::Environments::Valid#start_guard Ne
U
Guard::Deprecated::Guard::ClassMethods#lock Ne
U
Guard::Deprecated::Guardfile::ClassMethods Ne
U
Guard::Cli::Environments::Valid#initialize Ne
U
Guard::Guardfile::Evaluator#guardfile_path Ne
U
Guard::Deprecated::Watcher.add_deprecated Ne
U
Guard::Guardfile::Generator::NoSuchPlugin Ne
U
Guard::Watcher::Pattern::SimplePath#match Ne
U
Guard::Cli::Environments::Bundler#verify Ne
U
Guard::Deprecated::Watcher::ClassMethods Ne
U
Guard::Watcher::Pattern::MatchResult#[] Ne
U
Guard::Deprecated::Guard.add_deprecated Ne
U
Guard::Cli::Environments::EvaluateOnly Ne
U
Guard::Watcher::Pattern::Matcher#match Ne
U
Guard::Jobs::TerminalSettings#restore Ne
U
Guard::Deprecated::Dsl.add_deprecated Ne
U
Guard::Watcher::Pattern::PathnamePath Ne
U
Guard::Deprecated::Dsl::ClassMethods Ne
U
Guard::Watcher::Pattern::MatchResult Ne
U
Guard::Commands::Notification.import Ne
U
Guard::Watcher::Pattern::SimplePath Ne
U
Guard::Guardfile::Evaluator#options Ne
U
Guard::Jobs::TerminalSettings#save Ne
U
Guard::Jobs::TerminalSettings#echo Ne
U
Guard::Cli::Environments::Bundler Ne
U
Guard::Guardfile::Evaluator#path Ne
U
Guard::UI::Logger::Config#level= Ne
U
Guard::Watcher::Pattern::Matcher Ne
U
Guard::UI::Config#logger_config Ne
U
Guard::UI::Config#with_progname Ne
U
Guard::Cli::Environments::Valid Ne
U
Guard::DslDescriber#initialize Ne
U
Guard::Commands::Change.import Ne
U
Guard::Watcher::Pattern.create Ne
U
Guard::Commands::Reload.import Ne
U
Guard::Commands::Scope.import Ne
U
Guard::Commands::Pause.import Ne
U
Guard::DslReader#plugin_names Ne
U
Guard::Commands::Notification Ne
U
Guard::Jobs::TerminalSettings Ne
U
Guard::Deprecated::Evaluator Ne
U
Guard::Jobs::Base#background Ne
U
Guard::Jobs::Base#initialize Ne
U
Guard::Commands::Show.import Ne
U
Guard::Deprecated::Guardfile Ne
U
Guard::ArubaAdapter#execute Ne
U
Guard::Commands::All.import Ne
U
Guard::Deprecated::Watcher Ne
U
Guard::Notifier.disconnect Ne
U
Guard::Interactor.options Ne
U
Guard::UI::Logger::Config Ne
U
Guard::Deprecated::Guard Ne
U
Guard::Plugin#callbacks= Ne
U
Guard::UI::Config#except Ne
U
Guard::UI::Config#device Ne
U
Guard::Notifier.connect Ne
U
Guard::Commands::Change Ne
U
Guard::Plugin#callbacks Ne
U
Guard::Watcher::Pattern Ne
U
Guard::PluginUtil#name= Ne
U
Guard::Plugin#watchers= Ne
U
Guard::Commands::Reload Ne
U
Guard::Watcher#pattern= Ne
U
Guard::Notifier.turn_on Ne
U
Guard::Deprecated::Dsl Ne
U
Guard::Plugin#watchers Ne
U
Guard::Notifier.notify Ne
U
Guard::Plugin#options= Ne
U
Guard::UI::Config#only Ne
U
Guard::Notifier.toggle Ne
U
Guard::PluginUtil#name Ne
U
Guard::Watcher#pattern Ne
U
Guard::Commands::Pause Ne
U
Guard::Commands::Scope Ne
U
Guard::Watcher#action= Ne
U
Guard::Watcher#action Ne
U
Guard::Commander#stop Ne
U
Guard::Commander#show Ne
U
Guard::Plugin#options Ne
U
Guard::Group#options= Ne
U
Guard::Commands::Show Ne
U
Guard::Terminal.clear Ne
U
Guard::Plugin#group= Ne
U
Guard::UI::Config#[] Ne
U
Guard::Watcher#match Ne
U
Guard::Group#options Ne
U
Guard::Commands::All Ne
U
Guard::ArubaAdapter Ne
U
Guard::Plugin#group Ne
U
Releaser#initialize Ne
U
Guard::Jobs::Sleep Ne
U
Guard::Group#name= Ne
U
Guard::Interactor Ne
U
Guard::UI::Config Ne
U
Guard::Jobs::Base Ne
U
Releaser#rubygems Ne
U
Guard::Group#name Ne
U
Guard.interactor Ne
U
Guard::Terminal Ne
U
Releaser#github Ne
U
Guard::Notifier Ne
U
Guard::CLI.help Ne
U
Guard.listener Ne
U
Guard::Config Ne
U
Releaser#full Ne
U
Guard.queue Ne
U
Guard.state Ne
U
Guard.init Ne
U
Guard::Watcher::Pattern::SimplePath#normalize E
U
Guard::Guardfile::Evaluator#_use_default! E
U
Guard::Jobs::PryWrapper#initialize E
U
Guard::Jobs::PryWrapper#background E
U
Guard::Jobs::Sleep#background E
U
Guard::DslDescriber#_add_row E
U
Guard::UI::Colors 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.