#95 (all)
Ruby (change)
26 seconds
10 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.

Seems really good
A
Twitter::REST::FriendsAndFollowers#follow! N
A
Twitter::REST::Favorites#favorite! N
A
Twitter::REST::Tweets#retweet! N
A
Twitter::REST::FriendsAndFollowers#unfollow N
A
Twitter::REST::FriendsAndFollowers#follow N
A
Twitter::REST::Tweets#destroy_status N
A
Twitter::REST::Favorites#unfavorite N
A
Twitter::REST::Favorites#favorite N
A
Twitter::Streaming::Client#site N
A
Twitter::REST::DirectMessages#destroy_direct_message N
A
Twitter::REST::SavedSearches#destroy_saved_search N
A
Twitter::REST::FriendsAndFollowers#friendships N
A
Twitter::REST::DirectMessages#direct_messages N
A
Twitter::REST::SavedSearches#saved_searches N
A
Twitter::REST::FriendsAndFollowers#friends N
A
Twitter::REST::SpamReporting#report_spam N
A
Twitter::REST::Tweets#unretweet N
A
Twitter::REST::Tweets#statuses N
A
Twitter::REST::Tweets#retweet N
A
Twitter::REST::Tweets#oembeds N
A
Twitter::REST::Users#unblock N
A
Twitter::REST::Users#unmute N
A
Twitter::REST::Lists#lists N
A
Twitter::REST::Users#block N
A
Twitter::REST::Users#users N
A
Twitter::REST::Users#mute N
A
Twitter::REST::Tweets#retweeters_ids N
A
Twitter::REST::Undocumented#following_followers_of N
A
Twitter::REST::FriendsAndFollowers#follower_ids N
A
Twitter::REST::FriendsAndFollowers#friend_ids N
A
Twitter::REST::FriendsAndFollowers#followers N
A
Twitter::REST::SuggestedUsers#suggestions N
A
Twitter::Profile#profile_banner_uri_https N
A
Twitter::Profile#profile_image_uri_https N
A
Twitter::REST::Lists#remove_list_members N
A
Twitter::REST::Lists#remove_list_member N
A
Twitter::REST::Lists#add_list_members N
A
Twitter::REST::Lists#list_subscribers N
A
Twitter::REST::Lists#list_unsubscribe N
A
Twitter::REST::Lists#add_list_member N
A
Twitter::Profile#profile_banner_uri N
A
Twitter::REST::Users#profile_banner N
A
Twitter::REST::Lists#list_subscribe N
A
Twitter::REST::Favorites#favorites N
A
Twitter::REST::Lists#subscriptions N
A
Twitter::Profile#profile_image_uri N
A
Twitter::REST::Lists#list_timeline N
A
Twitter::REST::Lists#destroy_list N
A
Twitter::REST::Users#contributees N
A
Twitter::REST::Lists#list_members N
A
Twitter::REST::Users#contributors N
A
Twitter::REST::Lists#owned_lists N
A
Twitter::REST::Lists#list_update N
A
Twitter::REST::Lists#memberships N
A
Twitter::List#subscribers_uri N
A
Twitter::REST::Tweets#update! N
A
Twitter::List#members_uri N
A
Twitter::REST::Lists#list N
A
Twitter::REST::Users#user N
A
Twitter::Tweet#uri N
A
Twitter::List#uri N
A
Twitter::User#uri N
A
Twitter::Base.define_attribute_method N
A
Twitter::Base.define_predicate_method N
A
Twitter::Base.object_attr_reader N
A
Twitter::Base.define_uri_method N
A
Twitter::REST::DirectMessages#create_direct_message Ne
A
Twitter::REST::FriendsAndFollowers#no_retweet_ids Ne
A
Twitter::REST::FriendsAndFollowers#friendship Ne
A
Twitter::REST::Timelines#retweeted_by_user Ne
A
Twitter::REST::Timelines#mentions_timeline Ne
A
Twitter::REST::PlacesAndGeo#similar_places Ne
A
Twitter::REST::Trends#trends_available Ne
A
Twitter::REST::PlacesAndGeo#geo_search Ne
A
Twitter::REST::Trends#trends Ne
A
Twitter::REST::OAuth#token Ne
A
Twitter::Error Ne
A
Twitter::Base.uri_attr_reader Ne
A
Twitter::Base.attr_reader Ne
A
Twitter::Media::VideoInfo#aspect_ratio Ne
A
Twitter::REST::Timelines#user_timeline Ne
A
Twitter::Streaming::Client#firehose Ne
A
Twitter::Media::VideoInfo#variants Ne
A
Twitter::Configuration#photo_sizes Ne
A
Twitter::SearchResults#initialize Ne
A
Twitter::Streaming::Client#filter Ne
A
Twitter::Streaming::Client#sample Ne
A
Twitter::REST::Users#blocked_ids Ne
A
Twitter::Media::Video#video_info Ne
A
Twitter::TrendResults#initialize Ne
A
Twitter::Streaming::Client#user Ne
A
Twitter::GeoResults#initialize Ne
A
Twitter::REST::Users#muted_ids Ne
A
Twitter::Creatable#created_at Ne
A
Twitter::ProfileBanner#sizes Ne
A
Twitter::Error.from_response Ne
A
Twitter::REST::Search#search Ne
A
Twitter::Media::Video#sizes Ne
A
Twitter::Media::Photo#sizes Ne
A
Twitter::TrendResults#as_of Ne
A
Twitter::Base#initialize Ne
A
Twitter::Utils.flat_pmap Ne
A
Twitter::User#website Ne
A
Twitter::Utils.pmap Ne
A
Twitter::Cursor#initialize Ne
A
Twitter::Error#initialize Ne
A
Twitter::Base.display_uri_attr_reader Ne
A
Twitter::Base#[] Ne
A
Twitter::REST::FriendsAndFollowers#friendships_outgoing E
A
Twitter::REST::FriendsAndFollowers#friendships_incoming E
A
Twitter::REST::DirectMessages#direct_messages_received E
A
Twitter::REST::Users#update_profile_background_image E
A
Twitter::REST::FriendsAndFollowers#friendship_update E
A
Twitter::REST::DirectMessages#direct_messages_sent E
A
Twitter::REST::SavedSearches#create_saved_search E
A
Twitter::REST::DirectMessages#direct_message E
A
Twitter::REST::PlacesAndGeo#reverse_geocode E
A
Twitter::REST::SuggestedUsers#suggest_users E
A
Twitter::REST::Users#update_delivery_device E
A
Twitter::REST::Users#remove_profile_banner E
A
Twitter::REST::Users#update_profile_banner E
A
Twitter::REST::Users#update_profile_image E
A
Twitter::REST::SavedSearches#saved_search E
A
Twitter::REST::Timelines#retweeted_by_me E
A
Twitter::REST::Timelines#retweeted_to_me E
A
Twitter::REST::Users#verify_credentials E
A
Twitter::REST::Tweets#update_with_media E
A
Twitter::REST::Timelines#retweets_of_me E
A
Twitter::REST::Undocumented#tweet_count E
A
Twitter::REST::Timelines#home_timeline E
A
Twitter::REST::OAuth#invalidate_token E
A
Twitter::REST::Trends#trends_closest E
A
Twitter::REST::Users#update_profile E
A
Twitter::REST::Tweets#retweeters_of E
A
Twitter::REST::OAuth#reverse_token E
A
Twitter::REST::Help#configuration E
A
Twitter::REST::PlacesAndGeo#place E
A
Twitter::REST::Lists#merge_owner! E
A
Twitter::REST::Utils#merge_users! E
A
Twitter::REST::Users#user_search E
A
Twitter::REST::Lists#create_list E
A
Twitter::REST::Tweets#retweets E
A
Twitter::REST::Help#languages E
A
Twitter::REST::Users#settings E
A
Twitter::REST::Tweets#oembed E
A
Twitter::REST::Tweets#update E
A
Twitter::REST::Users#blocked E
A
Twitter::REST::Tweets#status E
A
Twitter::REST::Help#privacy E
A
Twitter::Client#initialize E
A
Twitter::REST::Users#muted E
A
Twitter::REST::Help#tos E
A
Twitter::Factory.new E
A
Twitter::Error::Code E
A
Twitter::REST::Lists#merge_list! E
A
Twitter::REST::Utils#merge_user! E
A
Twitter::REST::Lists#list_subscriber? E
A
Twitter::REST::Client#bearer_token E
A
Twitter::REST::Lists#list_member? E
A
Twitter::Relationship#initialize E
A
Twitter::User.define_entity_uris_methods E

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

This page is for sferik/twitter 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.