foreverjs/forever Forever

A simple CLI tool for ensuring that a given script runs c...

#41 (all)
JavaScript (change)
12 seconds
24 days 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.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
forever.startServer in /lib/forever.js E
A
cli.startDaemon in /lib/forever/cli.js E
A
cli.restartAll in /lib/forever/cli.js E
A
cli.cleanLogs in /lib/forever/cli.js E
A
cli.stopall in /lib/forever/cli.js E
Show 4 more ...
Proper documentation present
B
updateConfig in /lib/forever/cli.js E
B
checkColumn in /lib/forever/cli.js E
B
cli.restart in /lib/forever/cli.js E
B
cli.clear in /lib/forever/cli.js E
B
cli.stop in /lib/forever/cli.js E
Show 32 more ...
Please take a look
Undocumented
U
forever.columns.command.get in /lib/forever.js E
U
forever.columns.logfile.get in /lib/forever.js E
U
forever.columns.forever.get in /lib/forever.js E
U
forever.columns.script.get in /lib/forever.js E
U
forever.columns.uptime.get in /lib/forever.js E
Show 11 more ...

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

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