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.

Undocumented
U
Tinybucket N
U
Tinybucket::Resource::Base#create_enumerator N
U
Tinybucket::Request#delete_path Ne
U
Tinybucket::Request#patch_path Ne
U
Tinybucket::Request#post_path Ne
U
Tinybucket::NullLogger#fatal Ne
U
Tinybucket::NullLogger#debug Ne
U
Tinybucket::Request#put_path Ne
U
Tinybucket::Request#get_path Ne
U
Tinybucket::NullLogger#error Ne
U
Tinybucket::NullLogger#warn Ne
U
Tinybucket::NullLogger#info Ne
U
FaradayMiddleware::FollowOAuthRedirects#signature_params Ne
U
FaradayMiddleware::FollowOAuthRedirects#oauth_options Ne
U
FaradayMiddleware::FollowOAuthRedirects#oauth_header Ne
U
FaradayMiddleware::FollowOAuthRedirects#body_params Ne
U
FaradayMiddleware::FollowOAuthRedirects#update_env Ne
U
Tinybucket::Resource::PullRequest::Base#initialize Ne
U
Tinybucket::Api::Helper::BranchRestrictionsHelper Ne
U
Tinybucket::Parser::BaseParser#process_response Ne
U
Tinybucket::Error::BaseError#response_message Ne
U
Tinybucket::Resource::PullRequests#initialize Ne
U
Tinybucket::Error::ServiceError#http_headers= Ne
U
Tinybucket::Resource::Commit::Base#initialize Ne
U
Tinybucket::Error::BaseError#response_headers Ne
U
Tinybucket::Error::ServiceError#response_body Ne
U
Tinybucket::Parser::BranchRestrictionsParser Ne
U
Tinybucket::Error::ServiceError#http_headers Ne
U
Tinybucket::Api::Helper::PullRequestsHelper Ne
U
Tinybucket::Error::ServiceError#status_code Ne
U
Tinybucket::Error::ServiceError#request_url Ne
U
Tinybucket::Resource::Team::Base#initialize Ne
U
Tinybucket::Resource::Commit::BuildStatuses Ne
U
Tinybucket::Parser::BranchRestrictionParser Ne
U
Tinybucket::Resource::User::Base#initialize Ne
U
Tinybucket::Error::ServiceError#http_method Ne
U
Tinybucket::Api::BuildStatusApi#repo_owner= Ne
U
Tinybucket::Resource::PullRequest::Comments Ne
U
Tinybucket::Resource::PullRequest::Commits Ne
U
Tinybucket::Api::BuildStatusApi#repo_slug= Ne
U
Tinybucket::Api::Helper::BuildStatusHelper Ne
U
Tinybucket::Api::BuildStatusApi#repo_owner Ne
U
Tinybucket::Response::Handler#on_complete Ne
U
Tinybucket::Resource::Base#method_missing Ne
U
Tinybucket::Api::BuildStatusApi#repo_slug Ne
U
Tinybucket::Resource::Watchers#initialize Ne
U
Tinybucket::Resource::BranchRestrictions Ne
U
Tinybucket::Model::Concerns::ApiCallable Ne
U
Tinybucket::Model::BuildStatus#revision= Ne
U
Tinybucket::Resource::Commits#initialize Ne
U
Tinybucket::Resource::PullRequest::Base Ne
U
FaradayMiddleware::FollowOAuthRedirects Ne
U
Tinybucket::Model::BuildStatus#revision Ne
U
Tinybucket::Api::Helper::CommentsHelper Ne
U
Tinybucket::Error::BaseError#initialize Ne
U
Tinybucket::Resource::Repos#initialize Ne
U
Tinybucket::Api::Helper::CommitsHelper Ne
U
Tinybucket::Parser::PullRequestsParser Ne
U
Tinybucket::ApiFactory.create_instance Ne
U
Tinybucket::Resource::Commit::Comments Ne
U
Tinybucket::Resource::Forks#initialize Ne
U
Tinybucket::Resource::User::Followers Ne
U
Tinybucket::Parser::PullRequestParser Ne
U
Tinybucket::Resource::Team::Following Ne
U
Tinybucket::Resource::Team::Followers Ne
U
Tinybucket::Parser::BuildStatusParser Ne
U
Tinybucket::Resource::User::Following Ne
U
Tinybucket::Api::Helper::ReposHelper Ne
U
Tinybucket::Api::Helper::TeamHelper Ne
U
Tinybucket::Api::Helper::DiffHelper Ne
U
Tinybucket::Api::Helper::UserHelper Ne
U
Tinybucket::Model::Base#attributes= Ne
U
Tinybucket::Api::Helper::RepoHelper Ne
U
Tinybucket::Resource::Team::Members Ne
U
Tinybucket::Resource::PullRequests Ne
U
Tinybucket::Model::Base#attributes Ne
U
Tinybucket::Parser::CommentsParser Ne
U
Tinybucket::Parser::ProfilesParser Ne
U
Tinybucket::Resource::Commit::Base Ne
U
Tinybucket::Connection#clear_cache Ne
U
Tinybucket::Api::Helper::ApiHelper Ne
U
Tinybucket::Model::Base#initialize Ne
U
Tinybucket::Resource::Repos#create Ne
U
Tinybucket::Parser::CommitsParser Ne
U
Tinybucket::Resource::User::Repos Ne
U
Tinybucket::Parser::ProfileParser Ne
U
Tinybucket::Connection#connection Ne
U
Tinybucket::Parser::CommentParser Ne
U
Tinybucket::Resource::Team::Repos Ne
U
Tinybucket::Resource::User::Base Ne
U
Tinybucket::Resource::Team::Base Ne
U
Tinybucket::Resource::Repos#find Ne
U
Tinybucket::Parser::CommitParser Ne
U
Tinybucket::Parser::TeamsParser Ne
U
Tinybucket::Parser::ReposParser Ne
U
Tinybucket::Error::ServiceError Ne
U
Tinybucket::Parser::TeamParser Ne
U
Tinybucket::Resource::Watchers Ne
U
Tinybucket::Parser::BaseParser Ne
U
Tinybucket::Parser::RepoParser Ne
U
Tinybucket::Resource::Commits Ne
U
Tinybucket::NullLogger#level= Ne
U
Tinybucket::Response::Handler Ne
U
Tinybucket::Error::BaseError Ne
U
Tinybucket::NullLogger#level Ne
U
Tinybucket::Resource::Forks Ne
U
Tinybucket::Resource::Repos Ne
U
Tinybucket::Resource::Base Ne
U
Tinybucket::Iterator#next Ne
U
Tinybucket::Api::BaseApi Ne
U
Tinybucket::Model::Base Ne
U
Tinybucket.api_client= Ne
U
Tinybucket::Connection Ne
U
Tinybucket::NullLogger Ne
U
Tinybucket::Enumerator Ne
U
Tinybucket::ApiFactory Ne
U
Tinybucket.api_client Ne
U
Tinybucket.configure Ne
U
Tinybucket::Request Ne
U
Tinybucket::Client Ne
U
Tinybucket.logger= Ne
U
Tinybucket.config Ne
U
Tinybucket.logger Ne
U
Tinybucket.new Ne
U
Tinybucket::Resource::PullRequest::Base#pull_request_api E
U
Tinybucket::Resource::User::Base#create_user_enumerator E
U
Tinybucket::Resource::Team::Base#create_team_enumerator E
U
Tinybucket::Model::Concerns::ApiCallable#create_api E
U
Tinybucket::Resource::Base#inject_repo_keys E
U
Tinybucket::Resource::Team::Base#team_api E
U
Tinybucket::Resource::User::Base#user_api E
U
Tinybucket::Model::Base#logger E
U
FaradayMiddleware E
U
Tinybucket::Error::ServiceError#initialize E
U
Tinybucket::Model::Repository#initialize E
U
Tinybucket::Request#request E
U
Tinybucket::Constants 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.