danijoo/Sightstone
Sightstone is a ruby wrapper for riots league of legends developer api – Read the documentation
This page shows an evaluation of the documentation of danijoo/Sightstone.
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
|
Sightstone::TeamHistoryGame |
|
|
A
|
Sightstone::HistoryGame |
|
|
A
|
Sightstone::LeagueItem |
|
|
A
|
Sightstone::Champion |
|
|
A
|
Sightstone::Team |
|
| Show 284 more ... | ||
|
A
|
Sightstone::RankedStats#get_statistics_by_name |
|
|
A
|
Sightstone::SummonerModule#masterybooks |
|
|
A
|
Sightstone::LeagueModule#league_entries |
|
|
A
|
Sightstone::SummonerModule#masterybook |
|
|
A
|
Sightstone::SummonerModule#summoners |
|
|
A
|
Sightstone::SummonerModule#runebooks |
|
|
A
|
Sightstone::ChampionModule#champions |
|
|
A
|
Sightstone::SummonerModule#runebook |
|
|
A
|
Sightstone::SummonerModule#names |
|
|
A
|
Sightstone::LeagueModule#leagues |
|
|
A
|
Sightstone::GameModule#recent |
|
|
A
|
Sightstone::SummonerModule |
|
|
A
|
Sightstone::ChampionModule |
|
|
A
|
Sightstone::LeagueModule |
|
|
A
|
Sightstone::StatsModule |
|
|
A
|
Sightstone::TeamModule |
|
|
A
|
Sightstone::GameModule |
|
|
A
|
Sightstone::TeamStat |
|
|
A
|
Sightstone:: … #Array |
|
|
A
|
Sightstone:: … #Array |
|
|
A
|
Sightstone::PlayerStatSummary#playerStatSummaryType= |
|
|
A
|
Sightstone::PlayerStatSummary#playerStatSummaryType |
|
|
A
|
Sightstone::Team#lastJoinedRankedTeamQueueDate= |
|
|
A
|
Sightstone::Team#lastJoinedRankedTeamQueueDate |
|
|
A
|
Sightstone::PlayerStatsSummaryList#summonerId= |
|
|
A
|
Sightstone::TeamHistoryGame#opposingTeamKills= |
|
|
A
|
Sightstone::PlayerStatSummary#aggregatedStats= |
|
|
A
|
Sightstone::TeamHistoryGame#opposingTeamName= |
|
|
A
|
Sightstone::PlayerStatSummary#aggregatedStats |
|
|
A
|
Sightstone::TeamHistoryGame#opposingTeamKills |
|
|
A
|
Sightstone::PlayerStatsSummaryList#summonerId |
|
|
A
|
Sightstone::TeamHistoryGame#opposingTeamName |
|
|
A
|
Sightstone::MiniSeries#timeLeftToPlayMillis= |
|
|
A
|
Sightstone::MiniSeries#timeLeftToPlayMillis |
|
|
A
|
Sightstone::PlayerStatSummary#modifyDate= |
|
|
A
|
Sightstone::PlayerStatSummary#modifyDate |
|
|
A
|
Sightstone::TeamStat#averageFamesPlayed= |
|
|
A
|
Sightstone::LeagueItem#playerOrTeamName= |
|
|
A
|
Sightstone::LeagueItem#playerOrTeamName |
|
|
A
|
Sightstone::Champion#rankedPlayEnabled= |
|
|
A
|
Sightstone::TeamStat#averageFamesPlayed |
|
|
A
|
Sightstone::LeagueItem#playerOrTeamId= |
|
|
A
|
Sightstone::Champion#rankedPlayEnabled |
|
|
A
|
Sightstone::HistoryGame#fellowPlayers= |
|
|
A
|
Sightstone::PlayerStatSummary#losses= |
|
|
A
|
Sightstone::HistoryGame#fellowPlayers |
|
|
A
|
Sightstone::TeamHistoryGame#gameMode= |
|
|
A
|
Sightstone::LeagueItem#playerOrTeamId |
|
|
A
|
Sightstone::MatchHistory#summonerId= |
|
|
A
|
Sightstone::LeagueItem#leaguePoints= |
|
|
A
|
Sightstone::TeamHistoryGame#assists= |
|
|
A
|
Sightstone::Champion#difficultyRank= |
|
|
A
|
Sightstone::TeamHistoryGame#invalid= |
|
|
A
|
Sightstone::TeamHistoryGame#gameMode |
|
|
A
|
Sightstone::LeagueItem#isFreshBlood= |
|
|
A
|
Sightstone::PlayerStatSummary#losses |
|
|
A
|
Sightstone::Team#secondLastJoinDate= |
|
|
A
|
Sightstone::LeagueItem#isHotStreak= |
|
|
A
|
Sightstone::RankedStats#modifyDate= |
|
|
A
|
Sightstone::RankedStats#summonerId= |
|
|
A
|
Sightstone::HistoryGame#statistics= |
|
|
A
|
Sightstone::TeamHistoryGame#deaths= |
|
|
A
|
Sightstone::Team#secondLastJoinDate |
|
|
A
|
Sightstone::SummonerModule#summoner |
|
|
A
|
Sightstone::TeamHistoryGame#gameId= |
|
|
A
|
Sightstone::PlayerStatSummary#wins= |
|
|
A
|
Sightstone::TeamHistoryGame#assists |
|
|
A
|
Sightstone::MatchHistory#summonerId |
|
|
A
|
Sightstone::LeagueItem#leaguePoints |
|
|
A
|
Sightstone::TeamHistoryGame#invalid |
|
|
A
|
Sightstone::Summoner#profileIconId= |
|
|
A
|
Sightstone::Team#thridLastJoinDate= |
|
|
A
|
Sightstone::HistoryGame#championId= |
|
|
A
|
Sightstone::MasteryBook#summonerId= |
|
|
A
|
Sightstone::HistoryGame#createDate= |
|
|
A
|
Sightstone::Champion#difficultyRank |
|
|
A
|
Sightstone::LeagueItem#isFreshBlood |
|
|
A
|
Sightstone::MasteryBook#summonerId |
|
|
A
|
Sightstone::LeagueItem#miniSeries= |
|
|
A
|
Sightstone::HistoryGame#createDate |
|
|
A
|
Sightstone::TeamStat#teamStatType= |
|
|
A
|
Sightstone::HistoryGame#championId |
|
|
A
|
Sightstone::TeamHistoryGame#mapId= |
|
|
A
|
Sightstone::Team#thridLastJoinDate |
|
|
A
|
Sightstone::Champion#botMmEnabled= |
|
|
A
|
Sightstone::LeagueItem#leagueName= |
|
|
A
|
Sightstone::LeagueItem#lastPlayed= |
|
|
A
|
Sightstone::PlayerStatSummary#wins |
|
|
A
|
Sightstone::Summoner#profileIconId |
|
|
A
|
Sightstone::Summoner#revisionDate= |
|
|
A
|
Sightstone::TeamHistoryGame#kills= |
|
|
A
|
Sightstone::TeamHistoryGame#deaths |
|
|
A
|
Sightstone::TeamHistoryGame#gameId |
|
|
A
|
Sightstone::RankedStats#champions= |
|
|
A
|
Sightstone::RankedStats#summonerId |
|
|
A
|
Sightstone::HistoryGame#statistics |
|
|
A
|
Sightstone::RankedStats#modifyDate |
|
|
A
|
Sightstone::LeagueItem#isInactive= |
|
|
A
|
Sightstone::LeagueItem#isHotStreak |
|
|
A
|
Sightstone::LeagueItem#queueType= |
|
|
A
|
Sightstone::LeagueItem#lastPlayed |
|
|
A
|
Sightstone::Team#teamStatSummary= |
|
|
A
|
Sightstone::Summoner#revisionDate |
|
|
A
|
Sightstone::TeamStat#teamStatType |
|
|
A
|
Sightstone::Champion#defenseRank= |
|
|
A
|
Sightstone::RankedStats#champions |
|
|
A
|
Sightstone::LeagueItem#isInactive |
|
|
A
|
Sightstone::TeamHistoryGame#kills |
|
|
A
|
Sightstone::League#participantId= |
|
|
A
|
Sightstone::LeagueItem#miniSeries |
|
|
A
|
Sightstone::Champion#botMmEnabled |
|
|
A
|
Sightstone::LeagueItem#leagueName |
|
|
A
|
Sightstone::HistoryGame#gameType= |
|
|
A
|
Sightstone::HistoryGame#gameMode= |
|
|
A
|
Sightstone::TeamHistoryGame#mapId |
|
|
A
|
Sightstone::LeagueItem#isVeteran= |
|
|
A
|
Sightstone::MasteryPage#current= |
|
|
A
|
Sightstone::Champion#attackRank= |
|
|
A
|
Sightstone::Champion#botEnabled= |
|
|
A
|
Sightstone::Team#teamStatSummary |
|
|
A
|
Sightstone::TeamHistoryGame#win= |
|
|
A
|
Sightstone::MiniSeries#progress= |
|
|
A
|
Sightstone::RuneBook#summonerId= |
|
|
A
|
Sightstone::HistoryGame#gameMode |
|
|
A
|
Sightstone::HistoryGame#gameType |
|
|
A
|
Sightstone::HistoryGame#invalid= |
|
|
A
|
Sightstone::Champion#defenseRank |
|
|
A
|
Sightstone::LeagueItem#queueType |
|
|
A
|
Sightstone::Champion#freeToPlay= |
|
|
A
|
Sightstone::HistoryGame#subType= |
|
|
A
|
Sightstone::LeagueItem#isVeteran |
|
|
A
|
Sightstone::League#participantId |
|
|
A
|
Sightstone::HistoryGame#subType |
|
|
A
|
Sightstone::HistoryGame#teamId= |
|
|
A
|
Sightstone::Champion#freeToPlay |
|
|
A
|
Sightstone::HistoryGame#spell2= |
|
|
A
|
Sightstone::HistoryGame#spell1= |
|
|
A
|
Sightstone::RuneBook#summonerId |
|
|
A
|
Sightstone::HistoryGame#invalid |
|
|
A
|
Sightstone::HistoryGame#gameId= |
|
|
A
|
Sightstone::MatchHistory#games= |
|
|
A
|
Sightstone::StatsModule#summary |
|
|
A
|
Sightstone::Champion#botEnabled |
|
|
A
|
Sightstone::TeamHistoryGame#win |
|
|
A
|
Sightstone::Champion#attackRank |
|
|
A
|
Sightstone::MasteryPage#current |
|
|
A
|
Sightstone::MiniSeries#progress |
|
|
A
|
Sightstone::Champion#magicRank= |
|
|
A
|
Sightstone::HistoryGame#spell1 |
|
|
A
|
Sightstone::Champion#magicRank |
|
|
A
|
Sightstone::MasteryBook#pages= |
|
|
A
|
Sightstone::Team#lastGameDate= |
|
|
A
|
Sightstone::Team#lastJoinDate= |
|
|
A
|
Sightstone::MasteryPage#array= |
|
|
A
|
Sightstone::StatsModule#ranked |
|
|
A
|
Sightstone::Team#matchHistory= |
|
|
A
|
Sightstone::MatchHistory#games |
|
|
A
|
Sightstone::HistoryGame#gameId |
|
|
A
|
Sightstone::Roster#memberList= |
|
|
A
|
Sightstone::Member#inviteDate= |
|
|
A
|
Sightstone::HistoryGame#level= |
|
|
A
|
Sightstone::Player#summonerId= |
|
|
A
|
Sightstone::HistoryGame#mapId= |
|
|
A
|
Sightstone::MiniSeries#target= |
|
|
A
|
Sightstone::MiniSeries#losses= |
|
|
A
|
Sightstone::HistoryGame#spell2 |
|
|
A
|
Sightstone::Player#championId= |
|
|
A
|
Sightstone::HistoryGame#teamId |
|
|
A
|
Sightstone::HistoryGame#mapId |
|
|
A
|
Sightstone::MiniSeries#losses |
|
|
A
|
Sightstone::RunePage#current= |
|
|
A
|
Sightstone::MiniSeries#target |
|
|
A
|
Sightstone::Player#championId |
|
|
A
|
Sightstone::HistoryGame#level |
|
|
A
|
Sightstone::Roster#memberList |
|
|
A
|
Sightstone::Player#summonerId |
|
|
A
|
Sightstone::Team#matchHistory |
|
|
A
|
Sightstone::Rune#description= |
|
|
A
|
Sightstone::MasteryPage#array |
|
|
A
|
Sightstone::Team#lastJoinDate |
|
|
A
|
Sightstone::MasteryPage#name= |
|
|
A
|
Sightstone::Team#lastGameDate |
|
|
A
|
Sightstone::MasteryBook#pages |
|
|
A
|
Sightstone::Member#inviteDate |
|
|
A
|
Sightstone::TeamStat#fullId= |
|
|
A
|
Sightstone::Member#playerId= |
|
|
A
|
Sightstone::Rune#description |
|
|
A
|
Sightstone::RunePage#current |
|
|
A
|
Sightstone::Team#createDate= |
|
|
A
|
Sightstone::TeamStat#losses= |
|
|
A
|
Sightstone::Champion#active= |
|
|
A
|
Sightstone::MasteryPage#name |
|
|
A
|
Sightstone::Team#modifyDate= |
|
|
A
|
Sightstone::TeamModule#teams |
|
|
A
|
Sightstone::LeagueItem#rank= |
|
|
A
|
Sightstone::MiniSeries#wins= |
|
|
A
|
Sightstone::LeagueItem#tier= |
|
|
A
|
Sightstone::Member#joinDate= |
|
|
A
|
Sightstone::LeagueItem#wins= |
|
|
A
|
Sightstone::MasteryPage#id= |
|
|
A
|
Sightstone::LeagueItem#wins |
|
|
A
|
Sightstone::TeamStat#losses |
|
|
A
|
Sightstone::LeagueItem#tier |
|
|
A
|
Sightstone::Member#joinDate |
|
|
A
|
Sightstone::Roster#ownerId= |
|
|
A
|
Sightstone::MiniSeries#wins |
|
|
A
|
Sightstone::Member#playerId |
|
|
A
|
Sightstone::RuneBook#pages= |
|
|
A
|
Sightstone::Team#createDate |
|
|
A
|
Sightstone::Summoner#level= |
|
|
A
|
Sightstone::Champion#active |
|
|
A
|
Sightstone::RunePage#slots= |
|
|
A
|
Sightstone::TeamStat#fullId |
|
|
A
|
Sightstone::Team#modifyDate |
|
|
A
|
Sightstone::LeagueItem#rank |
|
|
A
|
Sightstone::RunePage#slots |
|
|
A
|
Sightstone::Player#teamId= |
|
|
A
|
Sightstone::TeamStat#wins= |
|
|
A
|
Sightstone::RunePage#name= |
|
|
A
|
Sightstone::RuneBook#pages |
|
|
A
|
Sightstone::Roster#ownerId |
|
|
A
|
Sightstone::Summoner#level |
|
|
A
|
Sightstone::Member#status= |
|
|
A
|
Sightstone::MasteryPage#id |
|
|
A
|
Sightstone::Summoner#name= |
|
|
A
|
Sightstone::Champion#name= |
|
|
A
|
Sightstone::Champion#name |
|
|
A
|
Sightstone::TeamStat#wins |
|
|
A
|
Sightstone::League#queue= |
|
|
A
|
Sightstone::Player#teamId |
|
|
A
|
Sightstone::Member#status |
|
|
A
|
Sightstone::RunePage#name |
|
|
A
|
Sightstone::Summoner#name |
|
|
A
|
Sightstone::RunePage#id= |
|
|
A
|
Sightstone::Team#fullId= |
|
|
A
|
Sightstone::League#tier= |
|
|
A
|
Sightstone::League#queue |
|
|
A
|
Sightstone::Champion#id= |
|
|
A
|
Sightstone::Team#roster= |
|
|
A
|
Sightstone::League#name= |
|
|
A
|
Sightstone::Summoner#id= |
|
|
A
|
Sightstone::Team#status= |
|
|
A
|
Sightstone::Talent#name= |
|
|
A
|
Sightstone::Talent#rank= |
|
|
A
|
Sightstone::Talent#name |
|
|
A
|
Sightstone::Champion#id |
|
|
A
|
Sightstone::Team#status |
|
|
A
|
Sightstone::Summoner#id |
|
|
A
|
Sightstone::Team#fullId |
|
|
A
|
Sightstone::Talent#rank |
|
|
A
|
Sightstone::Team#roster |
|
|
A
|
Sightstone::League#name |
|
|
A
|
Sightstone::RunePage#id |
|
|
A
|
Sightstone::League#tier |
|
|
A
|
Sightstone::Talent#id= |
|
|
A
|
Sightstone::Rune#tier= |
|
|
A
|
Sightstone::Team#name= |
|
|
A
|
Sightstone::Rune#name= |
|
|
A
|
Sightstone::Team#name |
|
|
A
|
Sightstone::Rune#name |
|
|
A
|
Sightstone::Talent#id |
|
|
A
|
Sightstone::Rune#tier |
|
|
A
|
Sightstone::Team#tag= |
|
|
A
|
Sightstone::Rune#id= |
|
|
A
|
Sightstone::Team#tag |
|
|
A
|
Sightstone::Rune#id |
|
|
A
|
Sightstone::PlayerStatsSummaryList |
|
|
A
|
Sightstone::SightstoneBaseModule |
|
|
A
|
Sightstone::PlayerStatSummary |
|
|
A
|
Sightstone::MatchHistory |
|
|
A
|
Sightstone::RankedStats |
|
|
A
|
Sightstone::MasteryPage |
|
|
A
|
Sightstone::MasteryBook |
|
|
A
|
Sightstone::MiniSeries |
|
|
A
|
Sightstone::RunePage |
|
|
A
|
Sightstone::RuneBook |
|
|
A
|
Sightstone::Summoner |
|
|
A
|
Sightstone::Player |
|
|
A
|
Sightstone::Talent |
|
|
A
|
Sightstone::League |
|
|
A
|
Sightstone::Roster |
|
|
A
|
Sightstone::Member |
|
|
A
|
Sightstone::Rune |
|
|
A
|
Sightstone |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Sightstone::Sightstone#initialize |
|
|
B
|
Sightstone::Summoner#initialize |
|
| Needs work | ||
|---|---|---|
| – |
| Undocumented | ||
|---|---|---|
|
U
|
Sightstone::Sightstone |
|
|
U
|
Sightstone::PlayerStatsSummaryList#playerStatSummaries= |
|
|
U
|
Sightstone::PlayerStatsSummaryList#playerStatSummaries |
|
|
U
|
Sightstone::SightstoneBaseModule#_parse_response |
|
|
U
|
Sightstone::PlayerStatsSummaryList#initialize |
|
| Show 58 more ... | ||
|
U
|
Sightstone::TeamStat#averageGamesPlayed= |
|
|
U
|
Sightstone::PlayerStatSummary#initialize |
|
|
U
|
Sightstone::DatadragonModule#initialize |
|
|
U
|
Sightstone::TeamStat#averageGamesPlayed |
|
|
U
|
Sightstone::TeamHistoryGame#initialize |
|
|
U
|
Sightstone::SummonerModule#initialize |
|
|
U
|
Sightstone::ChampionModule#initialize |
|
|
U
|
Sightstone::DatadragonModule#version |
|
|
U
|
Sightstone::MatchHistory#initialize |
|
|
U
|
Sightstone::Team#thirdLastJoinDate= |
|
|
U
|
Sightstone::LeagueModule#initialize |
|
|
U
|
Sightstone::HistoryGame#initialize |
|
|
U
|
Sightstone::StatsModule#initialize |
|
|
U
|
Sightstone::RankedStats#initialize |
|
|
U
|
Sightstone::MasteryPage#initialize |
|
|
U
|
Sightstone::Team#thirdLastJoinDate |
|
|
U
|
Sightstone::MasteryBook#initialize |
|
|
U
|
Sightstone::MiniSeries#initialize |
|
|
U
|
Sightstone::LeagueItem#initialize |
|
|
U
|
Sightstone::TeamModule#initialize |
|
|
U
|
Sightstone::GameModule#initialize |
|
|
U
|
Sightstone::Sightstone#summoner= |
|
|
U
|
Sightstone::MasteryPage#talents= |
|
|
U
|
Sightstone::Sightstone#champion= |
|
|
U
|
Sightstone::RunePage#initialize |
|
|
U
|
Sightstone::Sightstone#champion |
|
|
U
|
Sightstone::Champion#initialize |
|
|
U
|
Sightstone::Sightstone#summoner |
|
|
U
|
Sightstone::Sightstone#api_key= |
|
|
U
|
Sightstone::TeamStat#initialize |
|
|
U
|
Sightstone::Sightstone#ddragon= |
|
|
U
|
Sightstone::RuneBook#initialize |
|
|
U
|
Sightstone::MasteryPage#talents |
|
|
U
|
Sightstone::Sightstone#ddragon |
|
|
U
|
Sightstone::Sightstone#league= |
|
|
U
|
Sightstone::Sightstone#region= |
|
|
U
|
Sightstone::Sightstone#api_key |
|
|
U
|
Sightstone::Sightstone#stats= |
|
|
U
|
Sightstone::Sightstone#region |
|
|
U
|
Sightstone::League#initialize |
|
|
U
|
Sightstone::Roster#initialize |
|
|
U
|
Sightstone::Player#initialize |
|
|
U
|
Sightstone::Talent#initialize |
|
|
U
|
Sightstone::Sightstone#league |
|
|
U
|
Sightstone::Member#initialize |
|
|
U
|
Sightstone::Sightstone#team= |
|
|
U
|
Sightstone::Sightstone#game= |
|
|
U
|
Sightstone::DatadragonModule |
|
|
U
|
Sightstone::Sightstone#stats |
|
|
U
|
Sightstone::League#entries= |
|
|
U
|
Sightstone::Sightstone#team |
|
|
U
|
Sightstone::Rune#initialize |
|
|
U
|
Sightstone::Sightstone#game |
|
|
U
|
Sightstone::Team#initialize |
|
|
U
|
Sightstone::League#entries |
|
|
U
|
Sightstone::Team#teamId= |
|
|
U
|
Sightstone::Team#teamId |
|
|
U
|
Sightstone::SightstoneBaseModule#_get_api_response |
|
Let's raise the visibility of documentation in Ruby!
This page is for danijoo/Sightstone 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)
Can I have my own badges?
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.
nch Pages