ruipgil/scraperjs Scraperjs

A complete and versatile web scraper.

#19 (all)
JavaScript (change)
27 seconds
over 2 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.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
DynamicScraper.generateMockErrorMessage in /src/DynamicScraper.js E
A
AbstractScraper#getStatusCode in /src/AbstractScraper.js E
A
DynamicScraper.closeFactory in /src/DynamicScraper.js E
A
DynamicScraper.startFactory in /src/DynamicScraper.js E
A
ScraperPromise#onStatusCode in /src/ScraperPromise.js E
Show 45 more ...
Proper documentation present
B
AbstractScraper.create in /src/AbstractScraper.js E
B
DynamicScraper.create in /src/DynamicScraper.js E
B
ScraperPromise#errorCallback in /src/ScraperPromise.js E
B
ScraperPromise#doneCallback in /src/ScraperPromise.js E
B
DynamicScraper#loadBody in /src/DynamicScraper.js E
Show 1 more ...
Please take a look
Undocumented
U
PhantomPoll#options.onStdout in /src/PhantomPoll.js E
U
PhantomPoll#options.onStderr in /src/PhantomPoll.js E
U
options.onStderr in /src/DynamicScraper.js E
U
options.onStdout in /src/DynamicScraper.js E
U
module.exports in /src/PhantomWrapper.js E

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

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