guard/guard Guard

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

Refresh
#70 (all)
Ruby (change)
14 seconds
almost 5 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.

Undocumented
U
Guard::Guardfile::Evaluator#guardfile_source Ne
U
Guard::Guardfile::Evaluator#guardfile_path Ne
U
Guard::Commands::Notification.import Ne
U
Guard::Notifier::Tmux.options_store Ne
U
Guard::Guardfile::Evaluator#options Ne
U
Guard::Guardfile::Generator#options Ne
U
Guard::Setuper#add_builtin_plugins Ne
U
Guard::Plugin::Base::ClassMethods Ne
U
Guard::Notifier::Base#initialize Ne
U
Guard::Commands::Change.import Ne
U
Guard::Plugin::Base#callbacks= Ne
U
Guard::Commands::Reload.import Ne
U
Guard::Notifier::Base#options Ne
U
Guard::Commands::Notification Ne
U
Guard::Commands::Scope.import Ne
U
Guard::Commands::Pause.import Ne
U
Guard::Plugin::Base#watchers= Ne
U
Guard::Plugin::Base#callbacks Ne
U
Guard::Plugin::Base#options= Ne
U
Guard::Setuper#restore_scope Ne
U
Guard::Plugin::Base#watchers Ne
U
Guard::Commands::Show.import Ne
U
Guard::DslDescriber#options Ne
U
Guard::Commands::All.import Ne
U
Guard::Plugin::Base#options Ne
U
Guard::Plugin::Base#group= Ne
U
Guard::Notifier#notifiers= Ne
U
Guard::Plugin::Base#group Ne
U
Guard::Setuper#interactor Ne
U
Guard::Interactor#thread= Ne
U
Guard::Notifier#notifiers Ne
U
Guard::Setuper#save_scope Ne
U
Guard::DeprecatedMethods Ne
U
Guard::Setuper#watchdirs Ne
U
Guard::Setuper#evaluator Ne
U
Guard::Interactor#thread Ne
U
Guard::Watcher#pattern= Ne
U
Guard::Commands::Change Ne
U
Guard::Commands::Reload Ne
U
Guard::PluginUtil#name= Ne
U
Guard::Commands::Scope Ne
U
Guard::Commands::Pause Ne
U
Guard::Setuper#options Ne
U
Guard::Watcher#action= Ne
U
Guard::PluginUtil#name Ne
U
Guard::Watcher#pattern Ne
U
Guard::Watcher#action Ne
U
Guard::Commands::Show Ne
U
Guard::Commander#show Ne
U
Guard::Group#options= Ne
U
Guard::Sheller#status Ne
U
Guard::Commands::All Ne
U
Guard::Group#options Ne
U
Guard::Reevaluator Ne
U
Guard::Group#name= Ne
U
Guard::Group#name Ne
U
Guard.listener= Ne
U
Guard.running= Ne
U
Guard.listener Ne
U
Guard.running Ne
U
Guard.runner= Ne
U
Guard.runner Ne
U
Guard.scope= Ne
U
Guard.lock= Ne
U
Guard.lock Ne
U
Guard::Notifier::GNTP#_register! E
U
Guard::DslDescriber#_add_row E
U
Guard::Deprecator 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.