Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
atomflunder committed Oct 7, 2023
1 parent e226b4a commit 7c31977
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ pub trait Rating {

/// Rating system for 1v1 matches.
///
/// 📌 _**Important note:**_ The Rating System Traits only implement the `rate` and `expected_score` functions.
/// 📌 _**Important note:**_ The RatingSystem Trait only implements the `rate` and `expected_score` functions.
/// Some rating systems might also implement additional functions (confidence interval, match quality, etc.) which you can only access by using those directly.
pub trait RatingSystem {
#[cfg(feature = "serde")]
Expand All @@ -499,8 +499,8 @@ pub trait RatingSystem {

/// Rating system for rating periods.
///
/// 📌 _**Important note:**_ The Rating System Traits only implement the `rate` and `expected_score` functions.
/// Some rating systems might also implement additional functions (confidence interval, match quality, etc.) which you can only access by using those directly.
/// 📌 _**Important note:**_ The RatingPeriodSystem Trait only implements the `rate` function.
/// Some rating systems might also implement additional functions which you can only access by using those directly.
pub trait RatingPeriodSystem {
#[cfg(feature = "serde")]
type RATING: Rating + Copy + std::fmt::Debug + DeserializeOwned + Serialize;
Expand All @@ -518,8 +518,8 @@ pub trait RatingPeriodSystem {

/// Rating system for two teams.
///
/// 📌 _**Important note:**_ The Rating System Traits only implement the `rate` and `expected_score` functions.
/// Some rating systems might also implement additional functions (confidence interval, match quality, etc.) which you can only access by using those directly.
/// 📌 _**Important note:**_ The TeamRatingSystem Trait only implements the `rate` and `expected_score` functions.
/// Some rating systems might also implement additional functions which you can only access by using those directly.
pub trait TeamRatingSystem {
#[cfg(feature = "serde")]
type RATING: Rating + Copy + std::fmt::Debug + DeserializeOwned + Serialize;
Expand All @@ -543,8 +543,8 @@ pub trait TeamRatingSystem {

/// Rating system for more than two teams.
///
/// 📌 _**Important note:**_ The Rating System Traits only implement the `rate` and `expected_score` functions.
/// Some rating systems might also implement additional functions (confidence interval, match quality, etc.) which you can only access by using those directly.
/// 📌 _**Important note:**_ The MultiTeamRatinngSystem Trait only implements the `rate` and `expected_score` functions.
/// Some rating systems might also implement additional functions which you can only access by using those directly.
pub trait MultiTeamRatingSystem {
#[cfg(feature = "serde")]
type RATING: Rating + Copy + std::fmt::Debug + DeserializeOwned + Serialize;
Expand Down

0 comments on commit 7c31977

Please sign in to comment.