#7 (all)
JavaScript (change)
13 seconds
over 4 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
AddIndexForPath in lib/gitdocs/migration/004_add_index_for_path.rb N
A
Gitdocs in lib/gitdocs/cli.rb N
A
Gitdocs::Repository::Path#revisions in lib/gitdocs/repository/path.rb Ne
A
Gitdocs::Initializer.initialize_old_paths in lib/gitdocs/initializer.rb Ne
A
Gitdocs::Initializer.initialize_database in lib/gitdocs/initializer.rb Ne
Show 33 more ...
Proper documentation present
B
Gitdocs::Repository::Path#initialize in lib/gitdocs/repository/path.rb Ne
B
Gitdocs::Repository#last_commit_for in lib/gitdocs/repository.rb Ne
B
Gitdocs::Notifier#initialize in lib/gitdocs/notifier.rb Ne
B
Gitdocs::Search#initialize in lib/gitdocs/search.rb Ne
B
Gitdocs::Server#initialize in lib/gitdocs/server.rb Ne
Show 3 more ...
Please take a look
C
Gitdocs::Share.create_by_path! in lib/gitdocs/share.rb N
C
Gitdocs::RenderingHelper::CodeRayify#block_code in lib/gitdocs/rendering_helper.rb Ne
C
Gitdocs::Repository#write_commit_message in lib/gitdocs/repository.rb Ne
C
Gitdocs::Notifier#merge_notification in lib/gitdocs/notifier.rb Ne
C
Gitdocs::Notifier#push_notification in lib/gitdocs/notifier.rb Ne
Show 17 more ...
Undocumented
U
AddStartWebFrontend in lib/gitdocs/migration/005_add_start_web_frontend.rb N
U
AddWebPortToConfig in lib/gitdocs/migration/006_add_web_port_to_config.rb N
U
AddRemoteBranch in lib/gitdocs/migration/002_add_remote_branch.rb N
U
CreateConfigs in lib/gitdocs/migration/003_create_configs.rb N
U
CreateShares in lib/gitdocs/migration/001_create_shares.rb N
Show 70 more ...

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

This page is for nesquena/gitdocs 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.