Skip to content

Commit ff42434

Browse files
committed
Forgot documentation
1 parent d3cff9a commit ff42434

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/steam_user_stats/get_global_stats_for_game.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,15 @@ pub struct Stat {
3535
}
3636

3737
impl Steam {
38+
/// Get the global stats for a game
39+
///
40+
/// # Arguments
41+
///
42+
/// * `appid` - The app ID for which to retrieve the stats for.
43+
/// * `count` - The number of stats to return (must be between 1,100 and equal to the number of names).
44+
/// * `names` - The names of the stats to return.
45+
///
46+
/// The `count` option being provided to the consumer needs to be reviewed as it could be automatically generated (`names.len()+1`)
3847
pub async fn get_global_stats_for_game(&self, appid: u32, count: u32, names: Vec<String>) -> Result<GlobalStats, SteamUserStatsError> {
3948
let url = format!("{}/{}/{}/v{}/", BASE, INTERFACE, ENDPOINT, VERSION);
4049

0 commit comments

Comments
 (0)