merqlove/do_snapshot Do snapshot

Snapshot creator for Digital Ocean droplets. Multi-thread...

#25 (all)
unknown (change)
6 seconds
over 1 year 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
Undocumented
U
DoSnapshot::Log#log N
U
DoSnapshot::Runner#initialize N
U
DoSnapshot::Adapter::Abstract#after_cleanup Ne
U
DoSnapshot::RequestActionError#initialize Ne
U
DoSnapshot::DropletPowerError#initialize Ne
U
DoSnapshot::DropletListError#initialize Ne
U
DoSnapshot::DropletFindError#initialize Ne
U
DoSnapshot::Command#fail_power_off Ne
U
DoSnapshot::EventError#initialize Ne
U
DoSnapshot::Command#initialize Ne
U
DoSnapshot::Adapter::DigitaloceanV2#snapshots Ne
U
DoSnapshot::Command#power_on_failed_droplets Ne
U
DoSnapshot::Adapter::DigitaloceanV2#client Ne
U
DoSnapshot::Helpers::UniversalLogger.close Ne
U
DoSnapshot::Adapter::Abstract#initialize Ne
U
DoSnapshot::Configuration#logger_level= Ne
U
DoSnapshot::Adapter::Abstract#stop_by= Ne
U
DoSnapshot::Adapter::Abstract#timeout= Ne
U
DoSnapshot::Configuration#logger_level Ne
U
DoSnapshot::Adapter::Abstract#timeout Ne
U
DoSnapshot::Adapter::Abstract#delay= Ne
U
DoSnapshot::Adapter::Abstract#delay Ne
U
DoSnapshot::Configuration#verbose= Ne
U
DoSnapshot::Configuration#logger= Ne
U
DoSnapshot::Command#reset_options Ne
U
DoSnapshot::Configuration#verbose Ne
U
DoSnapshot::Configuration#mailer= Ne
U
DoSnapshot::RequestActionError#id Ne
U
DoSnapshot::Configuration#mailer Ne
U
DoSnapshot::Configuration#logger Ne
U
DoSnapshot::Configuration#quiet= Ne
U
DoSnapshot::Command#load_options Ne
U
DoSnapshot::Command#stop_droplet Ne
U
DoSnapshot::Configuration#quiet Ne
U
DoSnapshot::Mail#smtp_default= Ne
U
DoSnapshot::Distribution.files Ne
U
DoSnapshot::Mail#opts_default= Ne
U
DoSnapshot::Mail#reset_options Ne
U
DoSnapshot::Mail#initialize Ne
U
DoSnapshot::Helpers#logger Ne
U
DoSnapshot::Log#initialize Ne
U
DoSnapshot::Helpers#mailer Ne
U
DoSnapshot::Log#instance= Ne
U
DoSnapshot::Mail#mailer= Ne
U
DoSnapshot::Log#instance Ne
U
DoSnapshot::Command#snap Ne
U
DoSnapshot::Log#verbose= Ne
U
DoSnapshot::Log#verbose Ne
U
DoSnapshot::Mail#mailer Ne
U
DoSnapshot::Adapter.api Ne
U
DoSnapshot::CLI#version Ne
U
DoSnapshot::Log#buffer= Ne
U
DoSnapshot::Log#buffer Ne
U
DoSnapshot::Log#quiet= Ne
U
DoSnapshot::Mail#smtp= Ne
U
DoSnapshot::Log#shell= Ne
U
DoSnapshot.reconfigure Ne
U
DoSnapshot::Mail#opts= Ne
U
DoSnapshot::Log#quiet Ne
U
DoSnapshot::Log#shell Ne
U
DoSnapshot::Mail#smtp Ne
U
DoSnapshot::Mail#opts Ne
U
DoSnapshot::Log#close Ne
U
DoSnapshot::CLI#snap Ne
U
DoSnapshot.configure Ne
U
Hash#symbolize_keys Ne
U
DoSnapshot.mailer= Ne
U
DoSnapshot.cleanup Ne
U
DoSnapshot.logger= Ne
U
DoSnapshot.config Ne
U
DoSnapshot.logger Ne
U
DoSnapshot.mailer Ne
U
DoSnapshot::Adapter::DigitaloceanV2#after_cleanup E
U
DoSnapshot::DropletShutdownError#initialize E
U
DoSnapshot::SnapshotCreateError#initialize E
U
DoSnapshot::Adapter::Abstract#check_keys E
U
DoSnapshot::Adapter::Abstract#stop_by E
U
DoSnapshot::Adapter::Abstract#set_id E
U
DoSnapshot::Command#stop_by_power= E
U
DoSnapshot::Command#stop_by_power E
U
DoSnapshot::Command#droplets= E
U
DoSnapshot::Mail#opts_default E
U
DoSnapshot::Command#protocol= E
U
DoSnapshot::Mail#setup_notify E
U
DoSnapshot::Mail#smtp_default E
U
DoSnapshot::Command#threads= E
U
DoSnapshot::Command#exclude= E
U
DoSnapshot::Command#timeout= E
U
DoSnapshot::Command#protocol E
U
DoSnapshot::Command#droplets E
U
DoSnapshot::Command#stop_by E
U
DoSnapshot::Command#threads E
U
DoSnapshot::Command#timeout E
U
DoSnapshot::Command#exclude E
U
DoSnapshot::Command#clean= E
U
DoSnapshot::Command#notify E
U
DoSnapshot::Command#quiet= E
U
DoSnapshot::Command#delay= E
U
DoSnapshot::Command#keep= E
U
DoSnapshot::Command#only= E
U
DoSnapshot::Command#quiet E
U
DoSnapshot::Command#stop= E
U
DoSnapshot::Command#delay E
U
DoSnapshot::Command#clean E
U
DoSnapshot::Command#keep E
U
DoSnapshot::Command#api= E
U
DoSnapshot::Command#stop E
U
DoSnapshot::Command#only E
U
DoSnapshot::Mail#logger E
U
DoSnapshot::Log#color E
U
DoSnapshot::Log#say E
U
DoSnapshot::Adapter::DigitaloceanV2#check_keys E

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

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