This page shows an evaluation of the documentation of sferik/twitter.
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! | |
A
|
Twitter::REST::Favorites#favorite! | |
A
|
Twitter::REST::Tweets#retweet! | |
A
|
Twitter::REST::FriendsAndFollowers#unfollow | |
A
|
Twitter::REST::FriendsAndFollowers#follow | |
Show 151 more ... | ||
A
|
Twitter::REST::Tweets#destroy_status | |
A
|
Twitter::REST::Favorites#unfavorite | |
A
|
Twitter::REST::Favorites#favorite | |
A
|
Twitter::Streaming::Client#site | |
A
|
Twitter::REST::DirectMessages#destroy_direct_message | |
A
|
Twitter::REST::SavedSearches#destroy_saved_search | |
A
|
Twitter::REST::FriendsAndFollowers#friendships | |
A
|
Twitter::REST::DirectMessages#direct_messages | |
A
|
Twitter::REST::SavedSearches#saved_searches | |
A
|
Twitter::REST::FriendsAndFollowers#friends | |
A
|
Twitter::REST::SpamReporting#report_spam | |
A
|
Twitter::REST::Tweets#statuses | |
A
|
Twitter::REST::Tweets#oembeds | |
A
|
Twitter::REST::Tweets#retweet | |
A
|
Twitter::REST::Users#unblock | |
A
|
Twitter::REST::Users#unmute | |
A
|
Twitter::REST::Lists#lists | |
A
|
Twitter::REST::Users#users | |
A
|
Twitter::REST::Users#block | |
A
|
Twitter::REST::Users#mute | |
A
|
Twitter::REST::Tweets#retweeters_ids | |
A
|
Twitter::REST::Undocumented#following_followers_of | |
A
|
Twitter::REST::FriendsAndFollowers#follower_ids | |
A
|
Twitter::REST::FriendsAndFollowers#friend_ids | |
A
|
Twitter::REST::FriendsAndFollowers#followers | |
A
|
Twitter::REST::SuggestedUsers#suggestions | |
A
|
Twitter::Profile#profile_banner_uri_https | |
A
|
Twitter::REST::Lists#remove_list_members | |
A
|
Twitter::Profile#profile_image_uri_https | |
A
|
Twitter::REST::Lists#remove_list_member | |
A
|
Twitter::REST::Lists#list_subscribers | |
A
|
Twitter::REST::Lists#add_list_members | |
A
|
Twitter::REST::Lists#list_unsubscribe | |
A
|
Twitter::REST::Lists#add_list_member | |
A
|
Twitter::REST::Users#profile_banner | |
A
|
Twitter::Profile#profile_banner_uri | |
A
|
Twitter::REST::Lists#list_subscribe | |
A
|
Twitter::REST::Lists#subscriptions | |
A
|
Twitter::Profile#profile_image_uri | |
A
|
Twitter::REST::Lists#list_timeline | |
A
|
Twitter::REST::Favorites#favorites | |
A
|
Twitter::REST::Users#contributors | |
A
|
Twitter::REST::Users#contributees | |
A
|
Twitter::REST::Lists#list_members | |
A
|
Twitter::REST::Lists#destroy_list | |
A
|
Twitter::REST::Lists#owned_lists | |
A
|
Twitter::REST::Lists#memberships | |
A
|
Twitter::REST::Lists#list_update | |
A
|
Twitter::REST::Tweets#update! | |
A
|
Twitter::List#subscribers_uri | |
A
|
Twitter::Cursor#initialize | |
A
|
Twitter::List#members_uri | |
A
|
Twitter::REST::Users#user | |
A
|
Twitter::REST::Lists#list | |
A
|
Twitter::Tweet#uri | |
A
|
Twitter::User#uri | |
A
|
Twitter::List#uri | |
A
|
Twitter::Base.define_predicate_method | |
A
|
Twitter::Base.define_attribute_method | |
A
|
Twitter::Base.object_attr_reader | |
A
|
Twitter::Base.define_uri_method | |
A
|
Twitter::REST::DirectMessages#create_direct_message | |
A
|
Twitter::REST::FriendsAndFollowers#no_retweet_ids | |
A
|
Twitter::REST::FriendsAndFollowers#friendship | |
A
|
Twitter::REST::PlacesAndGeo#similar_places | |
A
|
Twitter::REST::Timelines#retweeted_by_user | |
A
|
Twitter::REST::Timelines#mentions_timeline | |
A
|
Twitter::REST::Users#verify_credentials | |
A
|
Twitter::REST::PlacesAndGeo#geo_search | |
A
|
Twitter::REST::Trends#trends_available | |
A
|
Twitter::REST::Trends#trends | |
A
|
Twitter::REST::OAuth#token | |
A
|
Twitter::Error | |
A
|
Twitter::Base.uri_attr_reader | |
A
|
Twitter::Base.attr_reader | |
A
|
Twitter::Error::UnacceptableIO#initialize | |
A
|
Twitter::REST::Timelines#user_timeline | |
A
|
Twitter::Streaming::Client#firehose | |
A
|
Twitter::Configuration#photo_sizes | |
A
|
Twitter::SearchResults#initialize | |
A
|
Twitter::Streaming::Client#sample | |
A
|
Twitter::Streaming::Client#filter | |
A
|
Twitter::TrendResults#initialize | |
A
|
Twitter::REST::Users#blocked_ids | |
A
|
Twitter::Streaming::Client#user | |
A
|
Twitter::GeoResults#initialize | |
A
|
Twitter::Error::UnacceptableIO | |
A
|
Twitter::REST::Users#muted_ids | |
A
|
Twitter::Utils.pmap_with_index | |
A
|
Twitter::Creatable#created_at | |
A
|
Twitter::ProfileBanner#sizes | |
A
|
Twitter::REST::Search#search | |
A
|
Twitter::Error.from_response | |
A
|
Twitter::Media::Photo#sizes | |
A
|
Twitter::TrendResults#as_of | |
A
|
Twitter::Utils.flat_pmap | |
A
|
Twitter::Base#initialize | |
A
|
Twitter::User#website | |
A
|
Twitter::Utils.pmap | |
A
|
Twitter::Base.deprecate_attribute_method | |
A
|
Twitter::Base.display_uri_attr_reader | |
A
|
Twitter::Base#[] | |
A
|
Twitter::REST::FriendsAndFollowers#friendships_outgoing | |
A
|
Twitter::REST::FriendsAndFollowers#friendships_incoming | |
A
|
Twitter::REST::DirectMessages#direct_messages_received | |
A
|
Twitter::REST::FriendsAndFollowers#friendship_update | |
A
|
Twitter::REST::Users#update_profile_background_image | |
A
|
Twitter::REST::DirectMessages#direct_messages_sent | |
A
|
Twitter::REST::SavedSearches#create_saved_search | |
A
|
Twitter::REST::DirectMessages#direct_message | |
A
|
Twitter::REST::PlacesAndGeo#reverse_geocode | |
A
|
Twitter::REST::SuggestedUsers#suggest_users | |
A
|
Twitter::REST::Users#update_delivery_device | |
A
|
Twitter::REST::Users#update_profile_banner | |
A
|
Twitter::REST::Users#remove_profile_banner | |
A
|
Twitter::REST::Users#update_profile_colors | |
A
|
Twitter::REST::SavedSearches#saved_search | |
A
|
Twitter::REST::Users#update_profile_image | |
A
|
Twitter::REST::Timelines#retweeted_by_me | |
A
|
Twitter::REST::Timelines#retweeted_to_me | |
A
|
Twitter::REST::Undocumented#tweet_count | |
A
|
Twitter::REST::Timelines#retweets_of_me | |
A
|
Twitter::REST::Tweets#update_with_media | |
A
|
Twitter::REST::Timelines#home_timeline | |
A
|
Twitter::REST::OAuth#invalidate_token | |
A
|
Twitter::REST::Trends#trends_closest | |
A
|
Twitter::REST::Users#update_profile | |
A
|
Twitter::REST::Tweets#retweeters_of | |
A
|
Twitter::REST::OAuth#reverse_token | |
A
|
Twitter::REST::Help#configuration | |
A
|
Twitter::REST::PlacesAndGeo#place | |
A
|
Twitter::REST::Users#user_search | |
A
|
Twitter::REST::Lists#create_list | |
A
|
Twitter::REST::Tweets#retweets | |
A
|
Twitter::REST::Users#settings | |
A
|
Twitter::REST::Help#languages | |
A
|
Twitter::REST::Tweets#oembed | |
A
|
Twitter::REST::Users#blocked | |
A
|
Twitter::REST::Tweets#status | |
A
|
Twitter::REST::Tweets#update | |
A
|
Twitter::REST::Help#privacy | |
A
|
Twitter::REST::Users#muted | |
A
|
Twitter::Client#initialize | |
A
|
Twitter::REST::Help#tos | |
A
|
Twitter::REST::Client | |
A
|
Twitter::Factory.new | |
A
|
Twitter::REST::Lists#list_subscriber? | |
A
|
Twitter::REST::Client#bearer_token | |
A
|
Twitter::REST::Lists#list_member? | |
A
|
Twitter::Relationship#initialize | |
A
|
Twitter::Error::Code |
Proper documentation present | ||
---|---|---|
B
|
Twitter::Request#initialize | |
B
|
Twitter::Streaming::Client#before_request | |
B
|
Twitter::Streaming::Response#initialize | |
B
|
Twitter::Streaming::MessageParser.parse | |
B
|
Twitter::Request#perform_with_objects | |
Show 6 more ... | ||
B
|
Twitter::Request#perform_with_cursor | |
B
|
Twitter::Streaming::Event#initialize | |
B
|
Twitter::Arguments#initialize | |
B
|
Twitter::REST::Client#post | |
B
|
Twitter::REST::Client#get | |
B
|
Twitter::REST::Client#middleware |
Needs work | ||
---|---|---|
C
|
Twitter::Error#initialize | |
C
|
Twitter::Geo::Point#longitude | |
C
|
Twitter::Geo::Point#latitude | |
C
|
Twitter::RateLimit#reset_in | |
C
|
Twitter::Entities#uris | |
Show 24 more ... | ||
C
|
Twitter::Request#perform_with_object | |
C
|
Twitter::REST::Client#connection_options= | |
C
|
Twitter::REST::Client#connection_options | |
C
|
Twitter::REST::Client#middleware= | |
C
|
Twitter::TrendResults#location | |
C
|
Twitter::RateLimit#remaining | |
C
|
Twitter::RateLimit#reset_at | |
C
|
Twitter::Place#country_code | |
C
|
Twitter::Client#credentials | |
C
|
Twitter::Client#user_agent | |
C
|
Twitter::Place#place_type | |
C
|
Twitter::Suggestion#users | |
C
|
Twitter::GeoResults#token | |
C
|
Twitter::Enumerable#each | |
C
|
Twitter::Place#parent_id | |
C
|
Twitter::Request#perform | |
C
|
Twitter::RateLimit#limit | |
C
|
Twitter::Error.errors | |
C
|
Twitter::Version.to_s | |
C
|
Twitter::Entities#user_mentions | |
C
|
Twitter::Entities#hashtags | |
C
|
Twitter::Entities#symbols | |
C
|
Twitter::Tweet#full_text | |
C
|
Twitter::Entities#media |
Undocumented | ||
---|---|---|
U
|
Twitter::User#profile_background_image_url_https | |
U
|
Twitter::Configuration#short_url_length_https | |
U
|
Twitter::User#profile_background_image_url | |
U
|
Twitter::Configuration#short_url_length | |
U
|
Twitter::Tweet#in_reply_to_status_id | |
Show 219 more ... | ||
U
|
Twitter::Request#request_method | |
U
|
Twitter::User#favourites_count | |
U
|
Twitter::User#statuses_count | |
U
|
Twitter::SearchResults#attrs | |
U
|
Twitter::TrendResults#attrs | |
U
|
Twitter::Token#access_token | |
U
|
Twitter::DirectMessage#text | |
U
|
Twitter::GeoResults#attrs | |
U
|
Twitter::Geo#coordinates | |
U
|
Twitter::Cursor#attrs | |
U
|
Twitter::Base#attrs | |
U
|
Twitter::Size#h | |
U
|
Twitter::Size#w | |
U
|
Twitter::User | |
U
|
||
U
|
Twitter::Base.predicate_attr_reader | |
U
|
Twitter::REST::FriendsAndFollowers | |
U
|
Twitter::Configuration | |
U
|
Twitter::REST::Users | |
U
|
Twitter::REST::Lists | |
U
|
Twitter::OEmbed | |
U
|
Twitter::Client | |
U
|
Twitter::Tweet | |
U
|
Twitter::List | |
U
|
Twitter:: … #unparsable_status_codes | |
U
|
Twitter::Configuration#characters_reserved_per_media | |
U
|
Twitter::Streaming::Response#on_headers_complete | |
U
|
Twitter::Streaming::Connection#ssl_socket_class | |
U
|
Twitter::Streaming::Connection#tcp_socket_class | |
U
|
Twitter::REST::Response::RaiseError#on_complete | |
U
|
Twitter::REST::Request::MultipartWithFile#call | |
U
|
Twitter::REST::Response::ParseJson#on_complete | |
U
|
Twitter::Streaming::StallWarning#percent_full | |
U
|
Twitter::Streaming::Client#ssl_socket_class= | |
U
|
Twitter::Utils::ClassMethods#deprecate_alias | |
U
|
Twitter::Streaming::Client#tcp_socket_class= | |
U
|
Twitter::Streaming::Client#tcp_socket_class | |
U
|
Twitter::Configuration#max_media_per_upload | |
U
|
Twitter::Streaming::Client#ssl_socket_class | |
U
|
Twitter::User#profile_sidebar_border_color | |
U
|
Twitter::Configuration#non_username_paths | |
U
|
Twitter::REST::Request::MultipartWithFile | |
U
|
Twitter::Streaming::Connection#initialize | |
U
|
Twitter::Entity::UserMention#screen_name | |
U
|
Twitter::User#profile_sidebar_fill_color | |
U
|
Twitter::Streaming::DeletedTweet#user_id | |
U
|
Twitter::REST::Response::ParseJson#parse | |
U
|
Twitter::Streaming::StallWarning#message | |
U
|
Twitter::Configuration#photo_size_limit | |
U
|
Twitter::REST::Response::ParseErrorJson | |
U
|
Twitter::Streaming::Event#target_object | |
U
|
Twitter::Tweet#in_reply_to_screen_name | |
U
|
Twitter::Streaming::Client#connection= | |
U
|
Twitter::User#profile_background_color | |
U
|
Twitter::Streaming::Connection#stream | |
U
|
Twitter::Streaming::StallWarning#code | |
U
|
Twitter::Client#access_token_secret= | |
U
|
Twitter::Streaming::Response#on_body | |
U
|
Twitter::Client#access_token_secret | |
U
|
Twitter::REST::Response::RaiseError | |
U
|
Twitter::Tweet#in_reply_to_attrs_id | |
U
|
Twitter::REST::Client#bearer_token= | |
U
|
Twitter::REST::Response::ParseJson | |
U
|
Twitter::Tweet#in_reply_to_user_id | |
U
|
Twitter::Entity::UserMention#name | |
U
|
Twitter::Streaming::MessageParser | |
U
|
Twitter::Error.forbidden_messages | |
U
|
Twitter::Streaming::DeletedTweet | |
U
|
Twitter::Streaming::Event#source | |
U
|
Twitter::Streaming::Event#target | |
U
|
Twitter::User#profile_text_color | |
U
|
Twitter::User#profile_link_color | |
U
|
Twitter::Client#consumer_secret= | |
U
|
Twitter::Streaming::StallWarning | |
U
|
Twitter::Request#request_method= | |
U
|
Twitter::Entity::UserMention#id | |
U
|
Twitter::Streaming::Response#<< | |
U
|
Twitter::Client#consumer_secret | |
U
|
Twitter::BasicUser#screen_name | |
U
|
Twitter::Tweet#retweeted_tweet | |
U
|
Twitter::Streaming::Event#name | |
U
|
Twitter::Streaming::Connection | |
U
|
Twitter::List#subscriber_count | |
U
|
Twitter::Tweet#favorite_count | |
U
|
Twitter::Client#access_token= | |
U
|
Twitter::Client#consumer_key= | |
U
|
Twitter::Entity::Hashtag#text | |
U
|
Twitter::Media::Photo#indices | |
U
|
Twitter::SavedSearch#position | |
U
|
Twitter::Metadata#result_type | |
U
|
Twitter::User#followers_count | |
U
|
Twitter::OEmbed#provider_name | |
U
|
Twitter::REST::SuggestedUsers | |
U
|
Twitter::REST::DirectMessages | |
U
|
Twitter::Settings#screen_name | |
U
|
Twitter::Tweet#retweet_count | |
U
|
Twitter::Entity::UserMention | |
U
|
Twitter::Utils::ClassMethods | |
U
|
Twitter::Streaming::Response | |
U
|
Twitter::Settings#sleep_time | |
U
|
Twitter::Entity::Symbol#text | |
U
|
Twitter::Client#access_token | |
U
|
Twitter::REST::SavedSearches | |
U
|
Twitter::Client#consumer_key | |
U
|
Twitter::REST::SpamReporting | |
U
|
Twitter::REST::Undocumented | |
U
|
Twitter::User#friends_count | |
U
|
Twitter::Settings#time_zone | |
U
|
Twitter::Client#user_agent= | |
U
|
Twitter::OEmbed#author_name | |
U
|
Twitter::Tweet#filter_level | |
U
|
Twitter::REST::PlacesAndGeo | |
U
|
Twitter::Arguments#options | |
U
|
Twitter::Streaming::Client | |
U
|
Twitter::User#listed_count | |
U
|
Twitter::List#member_count | |
U
|
Twitter::Settings#language | |
U
|
Twitter::SavedSearch#query | |
U
|
Twitter::SavedSearch#name | |
U
|
Twitter::Place#attributes | |
U
|
Twitter::Error#rate_limit | |
U
|
Twitter::Streaming::Event | |
U
|
Twitter::User#description | |
U
|
Twitter::Token#token_type | |
U
|
Twitter::User#connections | |
U
|
Twitter::OEmbed#cache_age | |
U
|
Twitter::List#description | |
U
|
Twitter::Request#options= | |
U
|
Twitter::Language#status | |
U
|
Twitter::Request#client= | |
U
|
Twitter::REST::Favorites | |
U
|
Twitter::REST::Timelines | |
U
|
Twitter::Request#options | |
U
|
Twitter::Place#full_name | |
U
|
Twitter::Entity::Hashtag | |
U
|
Twitter::User#utc_offset | |
U
|
Twitter::Suggestion#slug | |
U
|
Twitter::Suggestion#name | |
U
|
Twitter::Suggestion#size | |
U
|
Twitter::Entity#indices | |
U
|
Twitter::Entity::Symbol | |
U
|
Twitter::OEmbed#version | |
U
|
Twitter::Request#client | |
U
|
Twitter::List#full_name | |
U
|
Twitter::User#time_zone | |
U
|
Twitter::Client#proxy= | |
U
|
Twitter::OEmbed#height | |
U
|
Twitter::SearchResults | |
U
|
Twitter::Request#path= | |
U
|
Twitter::Place#country | |
U
|
Twitter::Language#name | |
U
|
Twitter::User#location | |
U
|
Twitter::ProfileBanner | |
U
|
Twitter::DirectMessage | |
U
|
Twitter::Language#code | |
U
|
Twitter::Relationship | |
U
|
Twitter::Trend#events | |
U
|
Twitter::REST::Tweets | |
U
|
Twitter::Media::Photo | |
U
|
Twitter::Tweet#source | |
U
|
Twitter::MediaFactory | |
U
|
Twitter::Request#path | |
U
|
Twitter::REST::Trends | |
U
|
Twitter::OEmbed#width | |
U
|
Twitter::Place#woe_id | |
U
|
Twitter::TrendResults | |
U
|
Twitter::REST::Search | |
U
|
Twitter::Client#proxy | |
U
|
Twitter::Place#woeid | |
U
|
Twitter::Size#resize | |
U
|
Twitter::Trend#query | |
U
|
Twitter::Identity#id | |
U
|
Twitter::REST::OAuth | |
U
|
Twitter::REST::Utils | |
U
|
Twitter::OEmbed#type | |
U
|
Twitter::OEmbed#html | |
U
|
Twitter::SavedSearch | |
U
|
Twitter::Error#code | |
U
|
Twitter::GeoFactory | |
U
|
Twitter::REST::Help | |
U
|
Twitter::Trend#name | |
U
|
Twitter::GeoResults | |
U
|
Twitter::Geo::Point | |
U
|
Twitter::Enumerable | |
U
|
Twitter::Suggestion | |
U
|
Twitter::Place#name | |
U
|
Twitter::Tweet#text | |
U
|
Twitter::User#tweet | |
U
|
Twitter::Tweet#lang | |
U
|
Twitter::List#mode | |
U
|
Twitter::User#lang | |
U
|
Twitter::RateLimit | |
U
|
Twitter::List#name | |
U
|
Twitter::List#slug | |
U
|
Twitter::BasicUser | |
U
|
Twitter::Creatable | |
U
|
Twitter::User#name | |
U
|
Twitter::Arguments | |
U
|
Twitter::Metadata | |
U
|
Twitter::Entities | |
U
|
Twitter::Language | |
U
|
Twitter::Identity | |
U
|
Twitter::Settings | |
U
|
Twitter::Factory | |
U
|
Twitter::Request | |
U
|
Twitter::Profile | |
U
|
Twitter::Version | |
U
|
Twitter::Cursor | |
U
|
Twitter::Entity | |
U
|
Twitter::Token | |
U
|
Twitter::Place | |
U
|
Twitter::Trend | |
U
|
Twitter::Utils | |
U
|
Twitter::Base | |
U
|
Twitter::Size | |
U
|
Twitter::Geo | |
U
|
Twitter:: … #unparsable_status_codes | |
U
|
Twitter::Entities#uris? | |
U
|
Twitter::Streaming |
This page is for sferik/twitter
and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge:
(not counting low priority objects)
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.