Build #12 (all) Revision 96c211c9 Source github.com Documentation rubydoc.info

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.

Read the docs

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
Show 157 more ...
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#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::Users#block N
A
Twitter::REST::Users#users N
A
Twitter::REST::Lists#lists 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::Profile#profile_banner_uri_https N
A
Twitter::REST::SuggestedUsers#suggestions 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#list_subscribers N
A
Twitter::REST::Lists#add_list_members N
A
Twitter::REST::Lists#list_unsubscribe N
A
Twitter::REST::Lists#add_list_member N
A
Twitter::REST::Lists#list_subscribe N
A
Twitter::REST::Users#profile_banner N
A
Twitter::Profile#profile_banner_uri N
A
Twitter::REST::Lists#subscriptions N
A
Twitter::Profile#profile_image_uri N
A
Twitter::REST::Favorites#favorites N
A
Twitter::REST::Lists#list_timeline N
A
Twitter::REST::Lists#list_members N
A
Twitter::REST::Users#contributors N
A
Twitter::REST::Lists#destroy_list N
A
Twitter::REST::Users#contributees N
A
Twitter::REST::Lists#list_update N
A
Twitter::REST::Lists#memberships N
A
Twitter::REST::Lists#owned_lists N
A
Twitter::REST::Tweets#update! N
A
Twitter::List#subscribers_uri N
A
Twitter::Cursor#initialize 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::User#uri N
A
Twitter::List#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#mentions_timeline Ne
A
Twitter::REST::PlacesAndGeo#similar_places Ne
A
Twitter::REST::Timelines#retweeted_by_user Ne
A
Twitter::REST::Users#verify_credentials Ne
A
Twitter::REST::PlacesAndGeo#geo_search Ne
A
Twitter::REST::Trends#trends_available 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::Error::UnacceptableIO#initialize Ne
A
Twitter::REST::Timelines#user_timeline Ne
A
Twitter::Streaming::Client#firehose Ne
A
Twitter::Configuration#photo_sizes Ne
A
Twitter::Streaming::Client#filter Ne
A
Twitter::Streaming::Client#sample Ne
A
Twitter::SearchResults#initialize Ne
A
Twitter::REST::Users#blocked_ids Ne
A
Twitter::TrendResults#initialize Ne
A
Twitter::Streaming::Client#user Ne
A
Twitter::REST::Users#muted_ids Ne
A
Twitter::Error::UnacceptableIO Ne
A
Twitter::GeoResults#initialize Ne
A
Twitter::Creatable#created_at Ne
A
Twitter::Error.from_response Ne
A
Twitter::ProfileBanner#sizes Ne
A
Twitter::REST::Search#search Ne
A
Twitter::TrendResults#as_of Ne
A
Twitter::Media::Photo#sizes Ne
A
Twitter::Base#initialize Ne
A
Twitter::Utils.flat_pmap Ne
A
Twitter::User#website Ne
A
Twitter::Utils.pmap Ne
A
Twitter::Error#initialize Ne
A
Twitter::Base.display_uri_attr_reader Ne
A
Twitter::Base#[] Ne
A
Twitter::REST::FriendsAndFollowers#friendships_incoming E
A
Twitter::REST::FriendsAndFollowers#friendships_outgoing 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::Users#update_delivery_device E
A
Twitter::REST::SuggestedUsers#suggest_users E
A
Twitter::REST::Users#update_profile_banner E
A
Twitter::REST::Users#remove_profile_banner E
A
Twitter::REST::Users#update_profile_colors E
A
Twitter::REST::SavedSearches#saved_search E
A
Twitter::REST::Users#update_profile_image E
A
Twitter::REST::Timelines#retweeted_to_me E
A
Twitter::REST::Timelines#retweeted_by_me E
A
Twitter::REST::Tweets#update_with_media E
A
Twitter::REST::Undocumented#tweet_count E
A
Twitter::REST::Timelines#retweets_of_me 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::Tweets#retweeters_of E
A
Twitter::REST::Users#update_profile E
A
Twitter::REST::OAuth#reverse_token E
A
Twitter::REST::Utils#merge_users! E
A
Twitter::REST::PlacesAndGeo#place E
A
Twitter::REST::Lists#merge_owner! E
A
Twitter::REST::Help#configuration E
A
Twitter::REST::Lists#merge_list! E
A
Twitter::REST::Lists#create_list E
A
Twitter::REST::Users#user_search E
A
Twitter::REST::Tweets#retweets E
A
Twitter::REST::Users#settings E
A
Twitter::REST::Help#languages E
A
Twitter::REST::Tweets#update E
A
Twitter::REST::Users#blocked E
A
Twitter::REST::Tweets#status E
A
Twitter::REST::Tweets#oembed E
A
Twitter::REST::Media#upload 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::REST::Client E
A
Twitter::Factory.new E
A
Twitter::REST::Utils#merge_user! E
A
Twitter::Client#validate_credential_type! 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::Error::Code E
A
Twitter::User.define_entity_uris_methods E
Proper documentation present
B
Twitter::Request#initialize N
B
Twitter::Streaming::Client#before_request Ne
B
Twitter::Streaming::Response#initialize Ne
B
Twitter::Streaming::MessageParser.parse Ne
B
Twitter::Request#perform_with_objects Ne
Show 9 more ...
B
Twitter::Request#perform_with_cursor Ne
B
Twitter::Streaming::Event#initialize Ne
B
Twitter::Arguments#initialize Ne
B
Twitter::REST::Client#post Ne
B
Twitter::REST::Client#get Ne
B
Twitter::REST::Client#middleware E
B
Twitter::REST::Utils#objects_from_response_with_user E
B
Twitter::REST::Utils#cursor_from_response_with_user E
B
Twitter::REST::Utils#parallel_objects_from_response E
Please take a look
C
Twitter::Configuration#short_url_length_https N
C
Twitter::Configuration#short_url_length N
C
Twitter::Tweet#in_reply_to_status_id N
C
Twitter::User#favourites_count N
C
Twitter::Geo::Point#longitude N
Show 124 more ...
C
Twitter::SearchResults#attrs N
C
Twitter::Geo::Point#latitude N
C
Twitter::User#statuses_count N
C
Twitter::RateLimit#reset_in N
C
Twitter::DirectMessage#text N
C
Twitter::TrendResults#attrs N
C
Twitter::Token#access_token N
C
Twitter::GeoResults#attrs N
C
Twitter::Geo#coordinates N
C
Twitter::Cursor#attrs N
C
Twitter::Base#attrs N
C
Twitter::Size#w N
C
Twitter::Size#h N
C
Twitter::Entities#uris Ne
C
Twitter::Request#perform_with_object Ne
C
Twitter::Base.deprecate_attribute_method Ne
C
Twitter::Configuration#characters_reserved_per_media Ne
C
Twitter::Configuration#max_media_per_upload Ne
C
Twitter::User#profile_sidebar_border_color Ne
C
Twitter::REST::Client#connection_options= Ne
C
Twitter::Configuration#non_username_paths Ne
C
Twitter::REST::Client#connection_options Ne
C
Twitter::User#profile_sidebar_fill_color Ne
C
Twitter::Entity::UserMention#screen_name Ne
C
Twitter::Streaming::DeletedTweet#user_id Ne
C
Twitter::Configuration#photo_size_limit Ne
C
Twitter::User#profile_background_color Ne
C
Twitter::Tweet#in_reply_to_screen_name Ne
C
Twitter::Metadata#iso_language_code Ne
C
Twitter::Tweet#in_reply_to_user_id Ne
C
Twitter::REST::Client#middleware= Ne
C
Twitter::Entity::UserMention#name Ne
C
Twitter::User#profile_link_color Ne
C
Twitter::User#profile_text_color Ne
C
Twitter::Entity::UserMention#id Ne
C
Twitter::List#subscriber_count Ne
C
Twitter::BasicUser#screen_name Ne
C
Twitter::TrendResults#location Ne
C
Twitter::Tweet#favorite_count Ne
C
Twitter::User#followers_count Ne
C
Twitter::SavedSearch#position Ne
C
Twitter::OEmbed#provider_name Ne
C
Twitter::Entity::Hashtag#text Ne
C
Twitter::Settings#screen_name Ne
C
Twitter::Metadata#result_type Ne
C
Twitter::Media::Photo#indices Ne
C
Twitter::Entity::Symbol#text Ne
C
Twitter::RateLimit#remaining Ne
C
Twitter::Settings#sleep_time Ne
C
Twitter::Tweet#retweet_count Ne
C
Twitter::Client#user_agent= Ne
C
Twitter::Client#credentials Ne
C
Twitter::Place#country_code Ne
C
Twitter::User#friends_count Ne
C
Twitter::Tweet#filter_level Ne
C
Twitter::OEmbed#author_name Ne
C
Twitter::RateLimit#reset_at Ne
C
Twitter::Settings#time_zone Ne
C
Twitter::Client#user_agent Ne
C
Twitter::Arguments#options Ne
C
Twitter::User#listed_count Ne
C
Twitter::List#member_count Ne
C
Twitter::Settings#language Ne
C
Twitter::SavedSearch#query Ne
C
Twitter::User#description Ne
C
Twitter::Suggestion#users Ne
C
Twitter::Error#rate_limit Ne
C
Twitter::Place#place_type Ne
C
Twitter::SavedSearch#name Ne
C
Twitter::OEmbed#cache_age Ne
C
Twitter::List#description Ne
C
Twitter::Place#attributes Ne
C
Twitter::Token#token_type Ne
C
Twitter::User#connections Ne
C
Twitter::GeoResults#token Ne
C
Twitter::Suggestion#slug Ne
C
Twitter::Enumerable#each Ne
C
Twitter::Language#status Ne
C
Twitter::RateLimit#limit Ne
C
Twitter::Suggestion#size Ne
C
Twitter::Suggestion#name Ne
C
Twitter::Request#perform Ne
C
Twitter::User#utc_offset Ne
C
Twitter::Place#full_name Ne
C
Twitter::Place#parent_id Ne
C
Twitter::List#full_name Ne
C
Twitter::OEmbed#version Ne
C
Twitter::User#time_zone Ne
C
Twitter::Entity#indices Ne
C
Twitter::User#location Ne
C
Twitter::Language#code Ne
C
Twitter::Place#country Ne
C
Twitter::Language#name Ne
C
Twitter::OEmbed#height Ne
C
Twitter::Version.to_s Ne
C
Twitter::OEmbed#width Ne
C
Twitter::Tweet#source Ne
C
Twitter::Error.errors Ne
C
Twitter::Trend#events Ne
C
Twitter::OEmbed#type Ne
C
Twitter::Size#resize Ne
C
Twitter::Trend#query Ne
C
Twitter::Identity#id Ne
C
Twitter::OEmbed#html Ne
C
Twitter::Place#name Ne
C
Twitter::Error#code Ne
C
Twitter::Trend#name Ne
C
Twitter::Tweet#text Ne
C
Twitter::Tweet#lang Ne
C
Twitter::List#mode Ne
C
Twitter::List#name Ne
C
Twitter::User#lang Ne
C
Twitter::User#name Ne
C
Twitter::List#slug Ne
C
Twitter::Entities#user_mentions E
C
Twitter::Entities#hashtags E
C
Twitter::Entities#symbols E
C
Twitter::Tweet#full_text E
C
Twitter::Entities#media E
C
Twitter::REST::Utils#perform_with_objects E
C
Twitter::REST::Utils#perform_with_object E
C
Twitter::Entities#entities E
C
Twitter::REST::Utils#perform_with_cursor E
C
Twitter::Cursor#next_cursor E
Undocumented
U
Twitter::Request#request_method N
U
Twitter::User N
U
Twitter N
U
Twitter::Utils::ClassMethods#deprecate_alias Ne
U
Twitter::Base.predicate_attr_reader Ne
Show 130 more ...
U
Twitter::REST::FriendsAndFollowers Ne
U
Twitter::Configuration Ne
U
Twitter::REST::Users Ne
U
Twitter::REST::Lists Ne
U
Twitter::Client Ne
U
Twitter::OEmbed Ne
U
Twitter::Tweet Ne
U
Twitter::List Ne
U
Twitter::REST::Response::ParseJson#unparsable_status_codes Ne
U
Twitter::Streaming::Response#on_headers_complete Ne
U
Twitter::Streaming::Connection#tcp_socket_class Ne
U
Twitter::REST::Response::RaiseError#on_complete Ne
U
Twitter::Streaming::Connection#ssl_socket_class Ne
U
Twitter::REST::Request::MultipartWithFile#call Ne
U
Twitter::REST::Response::ParseJson#on_complete Ne
U
Twitter::Streaming::StallWarning#percent_full Ne
U
Twitter::Streaming::Client#tcp_socket_class= Ne
U
Twitter::Streaming::Client#ssl_socket_class= Ne
U
Twitter::Streaming::Client#tcp_socket_class Ne
U
Twitter::Streaming::Client#ssl_socket_class Ne
U
Twitter::REST::Request::MultipartWithFile Ne
U
Twitter::Streaming::Connection#initialize Ne
U
Twitter::Streaming::StallWarning#message Ne
U
Twitter::REST::Response::ParseJson#parse Ne
U
Twitter::REST::Response::ParseErrorJson Ne
U
Twitter::Streaming::Event#target_object Ne
U
Twitter::Streaming::Client#connection= Ne
U
Twitter::Streaming::Connection#stream Ne
U
Twitter::Streaming::StallWarning#code Ne
U
Twitter::Streaming::Response#on_body Ne
U
Twitter::Client#access_token_secret= Ne
U
Twitter::REST::Client#bearer_token= Ne
U
Twitter::Client#access_token_secret Ne
U
Twitter::REST::Response::RaiseError Ne
U
Twitter::REST::Response::ParseJson Ne
U
Twitter::Error.forbidden_messages Ne
U
Twitter::Streaming::MessageParser Ne
U
Twitter::Client#consumer_secret= Ne
U
Twitter::Streaming::Event#target Ne
U
Twitter::Streaming::DeletedTweet Ne
U
Twitter::Streaming::StallWarning Ne
U
Twitter::Request#request_method= Ne
U
Twitter::Streaming::Event#source Ne
U
Twitter::Client#consumer_secret Ne
U
Twitter::Streaming::Response#<< Ne
U
Twitter::Tweet#retweeted_tweet Ne
U
Twitter::Streaming::Event#name Ne
U
Twitter::Streaming::Connection Ne
U
Twitter::Client#consumer_key= Ne
U
Twitter::REST::SuggestedUsers Ne
U
Twitter::Client#access_token= Ne
U
Twitter::REST::DirectMessages Ne
U
Twitter::Client#consumer_key Ne
U
Twitter::Streaming::Response Ne
U
Twitter::REST::SpamReporting Ne
U
Twitter::Client#access_token Ne
U
Twitter::Utils::ClassMethods Ne
U
Twitter::REST::SavedSearches Ne
U
Twitter::Entity::UserMention Ne
U
Twitter::REST::Undocumented Ne
U
Twitter::REST::PlacesAndGeo Ne
U
Twitter::Streaming::Client Ne
U
Twitter::Request#options= Ne
U
Twitter::Streaming::Event Ne
U
Twitter::Request#client= Ne
U
Twitter::REST::Favorites Ne
U
Twitter::REST::Timelines Ne
U
Twitter::Entity::Hashtag Ne
U
Twitter::Request#options Ne
U
Twitter::Entity::Symbol Ne
U
Twitter::Request#client Ne
U
Twitter::ProfileBanner Ne
U
Twitter::DirectMessage Ne
U
Twitter::Client#proxy= Ne
U
Twitter::SearchResults Ne
U
Twitter::Request#path= Ne
U
Twitter::Place#woe_id Ne
U
Twitter::Media::Photo Ne
U
Twitter::Relationship Ne
U
Twitter::Request#path Ne
U
Twitter::REST::Tweets Ne
U
Twitter::TrendResults Ne
U
Twitter::REST::Search Ne
U
Twitter::MediaFactory Ne
U
Twitter::REST::Trends Ne
U
Twitter::Client#proxy Ne
U
Twitter::REST::Utils Ne
U
Twitter::Place#woeid Ne
U
Twitter::REST::OAuth Ne
U
Twitter::SavedSearch Ne
U
Twitter::REST::Media Ne
U
Twitter::Enumerable Ne
U
Twitter::User#tweet Ne
U
Twitter::REST::Help Ne
U
Twitter::GeoResults Ne
U
Twitter::GeoFactory Ne
U
Twitter::Geo::Point Ne
U
Twitter::Suggestion Ne
U
Twitter::BasicUser Ne
U
Twitter::Creatable Ne
U
Twitter::RateLimit Ne
U
Twitter::Arguments Ne
U
Twitter::Identity Ne
U
Twitter::Language Ne
U
Twitter::Settings Ne
U
Twitter::Metadata Ne
U
Twitter::Entities Ne
U
Twitter::Factory Ne
U
Twitter::Profile Ne
U
Twitter::Version Ne
U
Twitter::Request Ne
U
Twitter::Cursor Ne
U
Twitter::Entity Ne
U
Twitter::Trend Ne
U
Twitter::Utils Ne
U
Twitter::Place Ne
U
Twitter::Token Ne
U
Twitter::Size Ne
U
Twitter::Base Ne
U
Twitter::Geo Ne
U
Twitter::REST::Utils#merge_default_cursor! E
U
Twitter::REST::Response::ParseErrorJson#unparsable_status_codes E
U
Twitter::User.define_entity_uris_method E
U
Twitter::REST::Client#request_headers E
U
Twitter::REST::Utils#set_compound_key E
U
Twitter::REST::Client#auth_header E
U
Twitter::Base#attrs_for_object E
U
Twitter::REST::Client#request E
U
Twitter::Entities#uris? E
U
Twitter::Streaming E

Let's raise the visibility of documentation in Ruby!

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!

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.

An open source project, created by René Föhring (@rrrene), based on Inch.