ingewortel/artistoo Artistoo

CPM implementation in pure javascript (Node module)

#13 (all)
JavaScript (change)
18 seconds
4 months 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
SoftConnectivityConstraint#postSetpixListener in /src/hamiltonian/SoftConnectivityConstraint.js Ne
ConnectivityConstraint#postSetpixListener in /src/hamiltonian/ConnectivityConstraint.js Ne
ActivityConstraint#postSetpixListener in /src/hamiltonian/ActivityConstraint.js Ne
PersistenceConstraint#setDirection in /src/hamiltonian/PersistenceConstraint.js Ne
GridBasedModel#setpixi in /src/models/GridBasedModel.js Ne
Show 184 more ...
Proper documentation present
Canvas#drawActivityValues in /src/Canvas.js E
PersistenceConstraint#sampleNorm in /src/hamiltonian/PersistenceConstraint.js E
PersistenceConstraint#randDir in /src/hamiltonian/PersistenceConstraint.js E
Canvas#drawFieldContour in /src/Canvas.js E
Canvas#drawField in /src/Canvas.js E
Show 3 more ...
Please take a look

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

This page is for ingewortel/artistoo 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.