hirakiuc/tinybucket Tinybucket

A Ruby client library for Bitbucket REST API v2 with OAut...

#11 (all)
Ruby (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.

Seems really good
A
Tinybucket::Client#repos N
A
Tinybucket::Model::PullRequest Ne
A
Tinybucket::Model::Repository Ne
A
Tinybucket::Model::Comment Ne
A
Tinybucket::Model::Profile Ne
A
Tinybucket::Model::Commit Ne
A
Tinybucket::Model::Team Ne
A
Tinybucket::Iterator#initialize Ne
A
Tinybucket::Resource::BranchRestrictions#initialize Ne
A
Tinybucket::Resource::Commit::BuildStatuses#create Ne
A
Tinybucket::Api::BranchRestrictionsApi#repo_owner Ne
A
Tinybucket::Model::Repository#branch_restrictions Ne
A
Tinybucket::Resource::PullRequest::Comments#find Ne
A
Tinybucket::Model::Repository#branch_restriction Ne
A
Tinybucket::Api::BranchRestrictionsApi#repo_slug Ne
A
Tinybucket::Resource::BranchRestrictions#create Ne
A
Tinybucket::Resource::BranchRestrictions#find Ne
A
Tinybucket::Api::PullRequestsApi#repo_owner Ne
A
Tinybucket::Model::Repository#pull_requests Ne
A
Tinybucket::Resource::Commit::Comments#find Ne
A
Tinybucket::Model::Repository#pull_request Ne
A
Tinybucket::Api::PullRequestsApi#repo_slug Ne
A
Tinybucket::Model::Commit#build_statuses Ne
A
Tinybucket::Api::PullRequestsApi#commits Ne
A
Tinybucket::Model::PullRequest#unapprove Ne
A
Tinybucket::Api::PullRequestsApi#decline Ne
A
Tinybucket::Api::CommentsApi#repo_owner Ne
A
Tinybucket::Model::PullRequest#comments Ne
A
Tinybucket::Resource::PullRequests#find Ne
A
Tinybucket::Model::PullRequest#approve Ne
A
Tinybucket::Model::PullRequest#decline Ne
A
Tinybucket::Api::PullRequestsApi#merge Ne
A
Tinybucket::Api::CommitsApi#repo_owner Ne
A
Tinybucket::Model::PullRequest#comment Ne
A
Tinybucket::Model::PullRequest#commits Ne
A
Tinybucket::Api::CommentsApi#repo_slug Ne
A
Tinybucket::Model::Repository#watchers Ne
A
Tinybucket::Model::Commit#build_status Ne
A
Tinybucket::Model::Repository#commits Ne
A
Tinybucket::Api::PullRequestsApi#diff Ne
A
Tinybucket::Api::PullRequestsApi#find Ne
A
Tinybucket::Api::CommitsApi#repo_slug Ne
A
Tinybucket::Api::PullRequestsApi#list Ne
A
Tinybucket::Api::CommitsApi#unapprove Ne
A
Tinybucket::Model::Repository#commit Ne
A
Tinybucket::Api::BuildStatusApi#find Ne
A
Tinybucket::Api::BuildStatusApi#post Ne
A
Tinybucket::Model::PullRequest#merge Ne
A
Tinybucket::Model::Profile#following Ne
A
Tinybucket::Model::Profile#followers Ne
A
Tinybucket::Model::BranchRestriction Ne
A
Tinybucket::Model::Repository#patch Ne
A
Tinybucket::Api::DiffApi#repo_owner Ne
A
Tinybucket::Model::PullRequest#diff Ne
A
Tinybucket::Api::DiffApi#find_patch Ne
A
Tinybucket::Api::CommitsApi#approve Ne
A
Tinybucket::Model::Commit#unapprove Ne
A
Tinybucket::Api::RepoApi#repo_owner Ne
A
Tinybucket::Api::BuildStatusApi#put Ne
A
Tinybucket::Model::Repository#forks Ne
A
Tinybucket::Api::DiffApi#repo_slug Ne
A
Tinybucket::Api::UserApi#followers Ne
A
Tinybucket::Model::Commit#comments Ne
A
Tinybucket::Model::Page#initialize Ne
A
Tinybucket::Api::TeamApi#following Ne
A
Tinybucket::Api::TeamApi#followers Ne
A
Tinybucket::Model::Repository#diff Ne
A
Tinybucket::Api::RepoApi#repo_slug Ne
A
Tinybucket::Resource::Commits#find Ne
A
Tinybucket::Api::UserApi#following Ne
A
Tinybucket::Model::Commit#approve Ne
A
Tinybucket::Model::Team#followers Ne
A
Tinybucket::Model::Commit#comment Ne
A
Tinybucket::Api::RepoApi#watchers Ne
A
Tinybucket::Model::Team#following Ne
A
Tinybucket::Model::Profile#repos Ne
A
Tinybucket::Api::TeamApi#members Ne
A
Tinybucket::Api::UserApi#profile Ne
A
Tinybucket::Model::Team#members Ne
A
Tinybucket::Api::RepoApi#forks Ne
A
Tinybucket::Api::UserApi#repos Ne
A
Tinybucket::Model::BuildStatus Ne
A
Tinybucket::Api::TeamApi#repos Ne
A
Tinybucket::Api::RepoApi#find Ne
A
Tinybucket::Model::Page#attrs Ne
A
Tinybucket::Api::DiffApi#find Ne
A
Tinybucket::Api::TeamApi#find Ne
A
Tinybucket::Model::Team#repos Ne
A
Tinybucket::Api::CommentsApi Ne
A
Tinybucket::Api::CommitsApi Ne
A
Tinybucket::Api::ReposApi Ne
A
Tinybucket::Client#team Ne
A
Tinybucket::Client#user Ne
A
Tinybucket::Client#repo Ne
A
Tinybucket::Iterator Ne
A
Tinybucket::Model::Page#items Ne
A
Tinybucket::Api::BranchRestrictionsApi#repo_owner= Ne
A
Tinybucket::Api::BranchRestrictionsApi#repo_slug= Ne
A
Tinybucket::Api::PullRequestsApi#repo_owner= Ne
A
Tinybucket::Api::PullRequestsApi#repo_slug= Ne
A
Tinybucket::Api::CommentsApi#repo_owner= Ne
A
Tinybucket::Api::CommitsApi#repo_owner= Ne
A
Tinybucket::Api::CommentsApi#repo_slug= Ne
A
Tinybucket::Api::CommitsApi#repo_slug= Ne
A
Tinybucket::Api::RepoApi#repo_owner= Ne
A
Tinybucket::Api::DiffApi#repo_owner= Ne
A
Tinybucket::Api::RepoApi#repo_slug= Ne
A
Tinybucket::Api::DiffApi#repo_slug= Ne
A
Tinybucket::Resource::Commit::BuildStatuses#find E
A
Tinybucket::Model::BranchRestriction#destroy E
A
Tinybucket::Api::BranchRestrictionsApi#find E
A
Tinybucket::Api::BranchRestrictionsApi#list E
A
Tinybucket::Api::PullRequestsApi#unapprove E
A
Tinybucket::Api::PullRequestsApi#approve E
A
Tinybucket::Api::BranchRestrictionsApi E
A
Tinybucket::Model::BuildStatus#update E
A
Tinybucket::Model::Repository#destroy E
A
Tinybucket::Api::CommentsApi#find E
A
Tinybucket::Api::CommentsApi#list E
A
Tinybucket::Enumerator#initialize E
A
Tinybucket::Model::ErrorResponse E
A
Tinybucket::Api::CommitsApi#find E
A
Tinybucket::Api::CommitsApi#list E
A
Tinybucket::Api::PullRequestsApi E
A
Tinybucket::Api::BuildStatusApi E
A
Tinybucket::Api::ReposApi#list E
A
Tinybucket::Enumerator#size E
A
Tinybucket::Iterator#size E
A
Tinybucket::Api::TeamApi E
A
Tinybucket::Api::DiffApi E
A
Tinybucket::Api::RepoApi E
A
Tinybucket::Api::UserApi E
A
Tinybucket::Model::Page E
A
Tinybucket::Model::BranchRestriction#update E
A
Tinybucket::Resource::PullRequests#create E
A
Tinybucket::Model::PullRequest#update E

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

This page is for hirakiuc/tinybucket 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.