#101 (all)
Ruby (change)
25 seconds
5 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.

Undocumented
U
Twitter::REST::Request#request_method N
U
Twitter::Headers#initialize N
U
Twitter::REST::Request N
U
Twitter::Tweet N
U
Twitter::User N
U
Twitter N
U
Twitter::Base.predicate_attr_reader Ne
U
Twitter::REST::FriendsAndFollowers Ne
U
Twitter::Configuration Ne
U
Twitter::REST::Users Ne
U
Twitter::REST::Lists Ne
U
Twitter::REST::Utils Ne
U
Twitter::Client Ne
U
Twitter::OEmbed Ne
U
Twitter::List Ne
U
Twitter::Streaming::Response#on_headers_complete Ne
U
Twitter::Streaming::StallWarning#percent_full Ne
U
Twitter::DirectMessageEvent#created_timestamp Ne
U
Twitter::Streaming::StallWarning#message Ne
U
Twitter::Streaming::Event#target_object Ne
U
Twitter::REST::Request#request_method= Ne
U
Twitter::Streaming::Client#connection= Ne
U
Twitter::Streaming::StallWarning#code Ne
U
Twitter::Streaming::Response#on_body Ne
U
Twitter::Client#access_token_secret= Ne
U
Twitter::DirectMessage#recipient_id Ne
U
Twitter::Client#access_token_secret Ne
U
Twitter::REST::Client#bearer_token= Ne
U
Twitter::Headers#oauth_auth_header Ne
U
Twitter::REST::Request#rate_limit= Ne
U
Twitter::Streaming::MessageParser Ne
U
Twitter::REST::Request#rate_limit Ne
U
Twitter::Client#consumer_secret= Ne
U
Twitter::Streaming::StallWarning Ne
U
Twitter::Streaming::DeletedTweet Ne
U
Twitter::Streaming::Event#target Ne
U
Twitter::Streaming::Client#close Ne
U
Twitter::Streaming::Event#source Ne
U
Twitter::DirectMessage#sender_id Ne
U
Twitter::Headers#request_headers Ne
U
Twitter::Client#consumer_secret Ne
U
Twitter::REST::Request#options= Ne
U
Twitter::Streaming::Response#<< Ne
U
Twitter::REST::Request#headers= Ne
U
Twitter::Streaming::Event#name Ne
U
Twitter::REST::Request#headers Ne
U
Twitter::REST::Request#options Ne
U
Twitter::Tweet#retweeted_tweet Ne
U
Twitter::REST::Request#client= Ne
U
Twitter::REST::SuggestedUsers Ne
U
Twitter::Client#access_token= Ne
U
Twitter::REST::Request#client Ne
U
Twitter::Client#consumer_key= Ne
U
Twitter::Client#consumer_key Ne
U
Twitter::Streaming::Response Ne
U
Twitter::REST::SpamReporting Ne
U
Twitter::REST::SavedSearches Ne
U
Twitter::Entity::UserMention Ne
U
Twitter::REST::Request#path= Ne
U
Twitter::Client#access_token Ne
U
Twitter::REST::Request#path Ne
U
Twitter::Tweet#quoted_tweet Ne
U
Twitter::REST::Request#uri= Ne
U
Twitter::REST::Undocumented Ne
U
Twitter::REST::PlacesAndGeo Ne
U
Twitter::DirectMessageEvent Ne
U
Twitter::REST::Request#uri Ne
U
Twitter::REST::UploadUtils Ne
U
Twitter::Streaming::Client Ne
U
Twitter::Streaming::Event Ne
U
Twitter::Media::VideoInfo Ne
U
Twitter::Client#timeouts= Ne
U
Twitter::REST::Timelines Ne
U
Twitter::Entity::Hashtag Ne
U
Twitter::Client#timeouts Ne
U
Twitter::REST::Favorites Ne
U
Twitter::Entity::Symbol Ne
U
Twitter::DirectMessage Ne
U
Twitter::SearchResults Ne
U
Twitter::Client#proxy= Ne
U
Twitter::ProfileBanner Ne
U
Twitter::TrendResults Ne
U
Twitter::Place#woe_id Ne
U
Twitter::Relationship Ne
U
Twitter::Client#proxy Ne
U
Twitter::REST::Tweets Ne
U
Twitter::REST::Trends Ne
U
Twitter::Media::Photo Ne
U
Twitter::REST::Client Ne
U
Twitter::REST::Search Ne
U
Twitter::Media::Video Ne
U
Twitter::MediaFactory Ne
U
Twitter::Place#woeid Ne
U
Twitter::SavedSearch Ne
U
Twitter::REST::OAuth Ne
U
Twitter::Suggestion Ne
U
Twitter::GeoFactory Ne
U
Twitter::REST::Help Ne
U
Twitter::Enumerable Ne
U
Twitter::User#tweet Ne
U
Twitter::GeoResults Ne
U
Twitter::Geo::Point Ne
U
Twitter::Arguments Ne
U
Twitter::Creatable Ne
U
Twitter::BasicUser Ne
U
Twitter::Identity Ne
U
Twitter::Entities Ne
U
Twitter::Language Ne
U
Twitter::Metadata Ne
U
Twitter::Settings Ne
U
Twitter::Version Ne
U
Twitter::Headers Ne
U
Twitter::Profile Ne
U
Twitter::Factory Ne
U
Twitter::Variant Ne
U
Twitter::Entity Ne
U
Twitter::Cursor Ne
U
Twitter::Place Ne
U
Twitter::Utils Ne
U
Twitter::Trend Ne
U
Twitter::Size Ne
U
Twitter::Base Ne
U
Twitter::Geo Ne
U
Twitter::REST::Request#set_multipart_options! E
U
Twitter::REST::Request#merge_multipart_file! E
U
Twitter::REST::Lists#merge_slug_and_owner! E
U
Twitter::REST::Lists#merge_list_and_owner! E
U
Twitter::REST::Utils#merge_default_cursor! E
U
Twitter::REST::Request#symbolize_keys! E
U
Twitter::User.define_entity_uris_method E
U
Twitter::REST::Utils#set_compound_key E
U
Twitter::Base#attrs_for_object E
U
Twitter::Entities#uris? 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.