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.

Please take a look
C
Tinybucket::Model::PullRequest#close_source_branch= Ne
C
Tinybucket::Model::PullRequest#close_source_branch Ne
C
Tinybucket::Model::BranchRestriction#pattern= Ne
C
Tinybucket::Model::PullRequest#comment_count= Ne
C
Tinybucket::Model::BranchRestriction#pattern Ne
C
Tinybucket::Model::BranchRestriction#groups= Ne
C
Tinybucket::Model::PullRequest#comment_count Ne
C
Tinybucket::Model::PullRequest#merge_commit= Ne
C
Tinybucket::Model::PullRequest#participants= Ne
C
Tinybucket::Model::PullRequest#description= Ne
C
Tinybucket::Model::PullRequest#destination= Ne
C
Tinybucket::Model::BranchRestriction#groups Ne
C
Tinybucket::Model::BranchRestriction#links= Ne
C
Tinybucket::Model::BranchRestriction#users= Ne
C
Tinybucket::Model::PullRequest#merge_commit Ne
C
Tinybucket::Model::BuildStatus#description= Ne
C
Tinybucket::Model::PullRequest#participants Ne
C
Tinybucket::Model::PullRequest#created_on= Ne
C
Tinybucket::Model::PullRequest#updated_on= Ne
C
Tinybucket::Model::Repository#description= Ne
C
Tinybucket::Model::PullRequest#description Ne
C
Tinybucket::Model::PullRequest#task_count= Ne
C
Tinybucket::Model::BranchRestriction#kind= Ne
C
Tinybucket::Model::BranchRestriction#links Ne
C
Tinybucket::Model::Repository#fork_policy= Ne
C
Tinybucket::Api::CommentsApi#commented_to= Ne
C
Tinybucket::Model::BranchRestriction#uuid= Ne
C
Tinybucket::Model::PullRequest#destination Ne
C
Tinybucket::Model::BuildStatus#description Ne
C
Tinybucket::Model::BranchRestriction#users Ne
C
Tinybucket::Model::Repository#has_issues= Ne
C
Tinybucket::Model::Repository#is_private= Ne
C
Tinybucket::Model::BranchRestriction#uuid Ne
C
Tinybucket::Model::BranchRestriction#kind Ne
C
Tinybucket::Model::Repository#created_on= Ne
C
Tinybucket::Model::Repository#description Ne
C
Tinybucket::Api::CommentsApi#commented_to Ne
C
Tinybucket::Model::ErrorResponse#message= Ne
C
Tinybucket::Model::Repository#updated_on= Ne
C
Tinybucket::Model::PullRequest#created_on Ne
C
Tinybucket::Model::PullRequest#reviewers= Ne
C
Tinybucket::Model::PullRequest#closed_by= Ne
C
Tinybucket::Model::PullRequest#updated_on Ne
C
Tinybucket::Model::PullRequest#task_count Ne
C
Tinybucket::Model::Repository#fork_policy Ne
C
Tinybucket::Model::Repository#updated_on Ne
C
Tinybucket::Model::Repository#created_on Ne
C
Tinybucket::Model::Repository#has_issues Ne
C
Tinybucket::Model::Repository#is_private Ne
C
Tinybucket::Model::Repository#full_name= Ne
C
Tinybucket::Model::Profile#display_name= Ne
C
Tinybucket::Model::PullRequest#reviewers Ne
C
Tinybucket::Model::ErrorResponse#message Ne
C
Tinybucket::Model::Comment#commented_to= Ne
C
Tinybucket::Model::ErrorResponse#fields= Ne
C
Tinybucket::Model::PullRequest#closed_by Ne
C
Tinybucket::Model::BranchRestriction#id= Ne
C
Tinybucket::Model::ErrorResponse#detail= Ne
C
Tinybucket::Model::Comment#commented_to Ne
C
Tinybucket::Model::Profile#display_name Ne
C
Tinybucket::Model::BranchRestriction#id Ne
C
Tinybucket::Model::Repository#language= Ne
C
Tinybucket::Model::Repository#has_wiki= Ne
C
Tinybucket::Model::Commit#participants= Ne
C
Tinybucket::Model::ErrorResponse#detail Ne
C
Tinybucket::Model::Repository#full_name Ne
C
Tinybucket::Model::ErrorResponse#fields Ne
C
Tinybucket::Model::Commit#participants Ne
C
Tinybucket::Model::PullRequest#reason= Ne
C
Tinybucket::Model::PullRequest#author= Ne
C
Tinybucket::Model::Repository#language Ne
C
Tinybucket::Model::Repository#has_wiki Ne
C
Tinybucket::Model::Repository#website= Ne
C
Tinybucket::Model::Profile#created_on= Ne
C
Tinybucket::Model::Comment#created_on= Ne
C
Tinybucket::Model::ErrorResponse#uuid= Ne
C
Tinybucket::Model::Comment#updated_on= Ne
C
Tinybucket::Model::PullRequest#source= Ne
C
Tinybucket::Model::Comment#updated_on Ne
C
Tinybucket::Model::Profile#created_on Ne
C
Tinybucket::Model::Commit#repository= Ne
C
Tinybucket::Model::Comment#created_on Ne
C
Tinybucket::Model::Team#display_name= Ne
C
Tinybucket::Model::PullRequest#state= Ne
C
Tinybucket::Model::Repository#website Ne
C
Tinybucket::Model::PullRequest#links= Ne
C
Tinybucket::Model::PullRequest#title= Ne
C
Tinybucket::Model::PullRequest#reason Ne
C
Tinybucket::Model::Repository#parent= Ne
C
Tinybucket::Model::PullRequest#author Ne
C
Tinybucket::Model::BuildStatus#state= Ne
C
Tinybucket::Model::PullRequest#source Ne
C
Tinybucket::Model::ErrorResponse#uuid Ne
C
Tinybucket::Model::BuildStatus#links= Ne
C
Tinybucket::Model::BuildStatus#type= Ne
C
Tinybucket::Model::Profile#username= Ne
C
Tinybucket::Model::ErrorResponse#id= Ne
C
Tinybucket::Model::Team#display_name Ne
C
Tinybucket::Model::Commit#repository Ne
C
Tinybucket::Model::PullRequest#uuid= Ne
C
Tinybucket::Model::PullRequest#type= Ne
C
Tinybucket::Model::Repository#links= Ne
C
Tinybucket::Model::Profile#location= Ne
C
Tinybucket::Model::Repository#owner= Ne
C
Tinybucket::Model::PullRequest#state Ne
C
Tinybucket::Model::Repository#parent Ne
C
Tinybucket::Model::PullRequest#title Ne
C
Tinybucket::Model::BuildStatus#links Ne
C
Tinybucket::Model::BuildStatus#name= Ne
C
Tinybucket::Model::PullRequest#links Ne
C
Tinybucket::Model::BuildStatus#state Ne
C
Tinybucket::Model::Comment#filename= Ne
C
Tinybucket::Model::Repository#owner Ne
C
Tinybucket::Model::BuildStatus#name Ne
C
Tinybucket::Model::BuildStatus#key= Ne
C
Tinybucket::Model::Comment#filename Ne
C
Tinybucket::Model::Profile#username Ne
C
Tinybucket::Model::BuildStatus#type Ne
C
Tinybucket::Model::Repository#uuid= Ne
C
Tinybucket::Model::BuildStatus#url= Ne
C
Tinybucket::Model::Comment#content= Ne
C
Tinybucket::Model::ErrorResponse#id Ne
C
Tinybucket::Model::Repository#type= Ne
C
Tinybucket::Model::Repository#links Ne
C
Tinybucket::Model::Profile#website= Ne
C
Tinybucket::Model::PullRequest#uuid Ne
C
Tinybucket::Model::Repository#size= Ne
C
Tinybucket::Model::PullRequest#type Ne
C
Tinybucket::Model::Repository#name= Ne
C
Tinybucket::Model::Team#created_on= Ne
C
Tinybucket::Model::Profile#location Ne
C
Tinybucket::Model::BuildStatus#url Ne
C
Tinybucket::Model::Commit#message= Ne
C
Tinybucket::Model::Comment#content Ne
C
Tinybucket::Model::PullRequest#id= Ne
C
Tinybucket::Model::Team#created_on Ne
C
Tinybucket::Model::Repository#size Ne
C
Tinybucket::Model::Repository#type Ne
C
Tinybucket::Model::Repository#name Ne
C
Tinybucket::Model::Profile#website Ne
C
Tinybucket::Model::Repository#scm= Ne
C
Tinybucket::Model::Repository#uuid Ne
C
Tinybucket::Model::Comment#inline= Ne
C
Tinybucket::Model::Commit#parents= Ne
C
Tinybucket::Model::Comment#parent= Ne
C
Tinybucket::Model::BuildStatus#key Ne
C
Tinybucket::Api::UserApi#username= Ne
C
Tinybucket::Model::Comment#inline Ne
C
Tinybucket::Model::Comment#links= Ne
C
Tinybucket::Model::Team#username= Ne
C
Tinybucket::Model::Team#location= Ne
C
Tinybucket::Api::UserApi#username Ne
C
Tinybucket::Model::Repository#scm Ne
C
Tinybucket::Model::Commit#message Ne
C
Tinybucket::Model::Commit#parents Ne
C
Tinybucket::Model::Commit#author= Ne
C
Tinybucket::Model::PullRequest#id Ne
C
Tinybucket::Model::Profile#links= Ne
C
Tinybucket::Model::Comment#parent Ne
C
Tinybucket::Model::Commit#author Ne
C
Tinybucket::Model::Comment#uuid= Ne
C
Tinybucket::Model::Comment#links Ne
C
Tinybucket::Model::Team#location Ne
C
Tinybucket::Model::Profile#links Ne
C
Tinybucket::Model::Profile#type= Ne
C
Tinybucket::Model::Comment#user= Ne
C
Tinybucket::Model::Profile#uuid= Ne
C
Tinybucket::Model::Commit#links= Ne
C
Tinybucket::Model::Team#website= Ne
C
Tinybucket::Model::Team#username Ne
C
Tinybucket::Model::Profile#kind= Ne
C
Tinybucket::Model::Commit#hash= Ne
C
Tinybucket::Model::Profile#kind Ne
C
Tinybucket::Model::Commit#type= Ne
C
Tinybucket::Model::Commit#date= Ne
C
Tinybucket::Model::Team#website Ne
C
Tinybucket::Model::Commit#uuid= Ne
C
Tinybucket::Model::Comment#user Ne
C
Tinybucket::Model::Commit#links Ne
C
Tinybucket::Model::Profile#uuid Ne
C
Tinybucket::Model::Comment#uuid Ne
C
Tinybucket::Model::Profile#type Ne
C
Tinybucket::Model::Team#links= Ne
C
Tinybucket::Model::Commit#uuid Ne
C
Tinybucket::Model::Commit#type Ne
C
Tinybucket::Model::Comment#id= Ne
C
Tinybucket::Model::Commit#date Ne
C
Tinybucket::Model::Commit#hash Ne
C
Tinybucket::Model::Team#uuid= Ne
C
Tinybucket::Model::Team#links Ne
C
Tinybucket::Model::Team#kind= Ne
C
Tinybucket::Model::Comment#id Ne
C
Tinybucket::Model::Team#type= Ne
C
Tinybucket::Model::Team#uuid Ne
C
Tinybucket::Model::Team#type Ne
C
Tinybucket::Model::Team#kind Ne

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.