fix doctests & rename n_misses to misses

src/any/attributes.rs

@@ -101,6 +101,11 @@ impl PerformanceAttributes {
             Self::Mania(attrs) => attrs.difficulty.max_combo,
         }
     }
+
+    /// Returns a builder for performance calculation.
+    pub fn performance<'a>(self) -> Performance<'a> {
+        self.into()
+    }
 }
 
 /// Abstract type to provide flexibility when passing difficulty attributes to a performance calculation.

src/any/performance/gradual.rs

@@ -31,7 +31,7 @@ use crate::{
 /// # Example
 ///
 /// ```
-/// use rosu_pp::{Beatmap, GradualPerformance, ModeDifficulty, ScoreState};
+/// use rosu_pp::{Beatmap, GradualPerformance, ModeDifficulty, any::ScoreState};
 ///
 /// let map = Beatmap::from_path("./resources/2785319.osu").unwrap();
 /// let difficulty = ModeDifficulty::new().mods(64); // DT
@@ -50,7 +50,7 @@ use crate::{
 /// // Then comes a miss.
 /// // Note that state's max combo won't be incremented for
 /// // the next few objects because the combo is reset.
-/// state.n_misses += 1;
+/// state.misses += 1;
 ///
 /// let performance = gradual_perf.next(state.clone()).unwrap();
 /// println!("PP: {}", performance.pp());

src/any/performance/mod.rs

@@ -172,12 +172,12 @@ impl<'map> Performance<'map> {
     }
 
     /// Specify the amount of misses of a play.
-    pub fn n_misses(self, n_misses: u32) -> Self {
+    pub fn misses(self, n_misses: u32) -> Self {
         match self {
-            Self::Osu(o) => Self::Osu(o.n_misses(n_misses)),
-            Self::Taiko(t) => Self::Taiko(t.n_misses(n_misses)),
+            Self::Osu(o) => Self::Osu(o.misses(n_misses)),
+            Self::Taiko(t) => Self::Taiko(t.misses(n_misses)),
             Self::Catch(f) => Self::Catch(f.misses(n_misses)),
-            Self::Mania(m) => Self::Mania(m.n_misses(n_misses)),
+            Self::Mania(m) => Self::Mania(m.misses(n_misses)),
         }
     }
 

src/any/score_state.rs

@@ -27,7 +27,7 @@ pub struct ScoreState {
     /// Amount of current 50s (tiny droplets for osu!catch).
     pub n50: u32,
     /// Amount of current misses (fruits + droplets for osu!catch).
-    pub n_misses: u32,
+    pub misses: u32,
 }
 
 impl ScoreState {
@@ -39,7 +39,7 @@ impl ScoreState {
     /// Return the total amount of hits by adding everything up based on the
     /// mode.
     pub fn total_hits(&self, mode: GameMode) -> u32 {
-        let mut amount = self.n300 + self.n100 + self.n_misses;
+        let mut amount = self.n300 + self.n100 + self.misses;
 
         if mode != GameMode::Taiko {
             amount += self.n50;
@@ -61,7 +61,7 @@ impl From<ScoreState> for OsuScoreState {
             n300: state.n300,
             n100: state.n100,
             n50: state.n50,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -72,7 +72,7 @@ impl From<ScoreState> for TaikoScoreState {
             max_combo: state.max_combo,
             n300: state.n300,
             n100: state.n100,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -85,7 +85,7 @@ impl From<ScoreState> for CatchScoreState {
             n_droplets: state.n100,
             n_tiny_droplets: state.n50,
             n_tiny_droplet_misses: state.n_katu,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -98,7 +98,7 @@ impl From<ScoreState> for ManiaScoreState {
             n200: state.n_katu,
             n100: state.n100,
             n50: state.n50,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -112,7 +112,7 @@ impl From<OsuScoreState> for ScoreState {
             n300: state.n300,
             n100: state.n100,
             n50: state.n50,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -126,7 +126,7 @@ impl From<TaikoScoreState> for ScoreState {
             n300: state.n300,
             n100: state.n100,
             n50: 0,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -140,7 +140,7 @@ impl From<CatchScoreState> for ScoreState {
             n300: state.n_fruits,
             n100: state.n_droplets,
             n50: state.n_tiny_droplets,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }
@@ -154,7 +154,7 @@ impl From<ManiaScoreState> for ScoreState {
             n300: state.n300,
             n100: state.n100,
             n50: state.n50,
-            n_misses: state.n_misses,
+            misses: state.misses,
         }
     }
 }