Adding documentation to undocumented attributes #36
Conversation
Hopefully these docs can help others who browse to this page and want to know what the various stats are and what they mean. Not all meanings were clear to me from data I've inspected, so I'm leaving some unspecified. Obviously anyone can come along later and propose a change to add info I didn't know how to add.
README.md
Outdated
| - `.name` - a string, the player's IGN | ||
| - `.shardId` - region from which the match was fetched, in lower case (e.g., `"na"`) | ||
| - `.stats` - an object with the following attributes: | ||
| - `elo_earned_season_4` - meaning unclear |
There was a problem hiding this comment.
Those values are all deprecated, they were replaced by rankPoints
README.md
Outdated
| - `lifetimeGold` - meaning unclear | ||
| - `lossStreak` - number of matches the player has lost in a row, or 0 if the last match was a win (but sometimes this number and `winStreak` are both zero, impossibly) | ||
| - `played` - meaning unclear | ||
| - `played_aral` - meaning unclear |
There was a problem hiding this comment.
they were replaced by gamesPlayed
README.md
Outdated
| - `itemSells` - similar in structure to the previous, but for selling items | ||
| - `itemUses` - an object whose keys are the names of items the player used, and whose values are the number of times the player used the item; example: `{"Travel Boots":3,"Scout Cam":3,...}` | ||
| - `items` - array of strings, all items the player possessed at the end of the match | ||
| - `jungleKills` - meaning uncertain |
README.md
Outdated
| - `.shardId` | ||
| - `.stats` | ||
| - `.titleId` | ||
| - `.createdAt` - a string, the match timestamp, suitable for passing to JavaScript `Date` constructor |
There was a problem hiding this comment.
This would be also good to highlight that it's the time on which the match was started, not when it ended
|
It looks really good to me, really helpful |
|
What's the best way for me to incorporate your corrections, @PierreAndreis ? Before now, I've never needed to modify a GitHub PR, so I'm not familiar with the process. |
|
@nathancarter any commits to the origin of this PR will show here. In this case, it's the branch If you are using the web UI, just modify this file https://github.com/nathancarter/vainglory/blob/patch-1/README.md |
|
OK...swamped at actual job at the moment...will get back to this...thanks! |
|
The changes you suggested have been made. Thank you! |
|
👍 |
|
Great, thanks, glad to be of some assistance. This repo is super helpful! |
* Adding documentation to undocumented attributes Hopefully these docs can help others who browse to this page and want to know what the various stats are and what they mean. Not all meanings were clear to me from data I've inspected, so I'm leaving some unspecified. Obviously anyone can come along later and propose a change to add info I didn't know how to add. * Improving this PR based on help from PierreAndreis
Hopefully these docs can help others who browse to this page and want to know what the various stats are and what they mean. Not all meanings were clear to me from data I've inspected, so I'm leaving some unspecified. Obviously anyone can come along later and propose a change to add info I didn't know how to add.