Skip to content

Commit

Permalink
Fix engine docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gpluscb committed Mar 31, 2022
1 parent 7a460ec commit 519ab18
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license = "MIT"
keywords = ["glicko-2", "glicko", "rating", "elo"]
categories = ["game-development", "mathematics"]
description = "Implementation of the Glicko-2 rating system that allows for instant feedback after games, not just once a rating period closes"
# rust-version = # TODO
# TODO: rust-version =

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
5 changes: 4 additions & 1 deletion src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,10 @@ impl RatingEngine {
self.player_rating_at(player, Instant::now())
}

/// Returns a player
/// Calculates a player's rating at a given point in time.
/// The calculation is based on the registered results for this player (see [`register_result`][Self::register_result]).
/// Note that this function is not cheap.
/// The rating deviation of this result also depends on the current time, because rating deviation increases with time.
///
/// This function is meant mostly for testability.
///
Expand Down

0 comments on commit 519ab18

Please sign in to comment.