doc: fixed documentation

MaxOhn · Dec 29, 2023 · d9bf324 · d9bf324
1 parent f3c39c7
commit d9bf324
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/pp.rs b/src/pp.rs
@@ -96,7 +96,10 @@ impl<'map> AnyPP<'map> {
     }
 
     /// If the map is an osu!standard map, convert it to another mode.
-    // TODO: option necessary?
+    ///
+    /// Returns `None` if `self` already replaced it's internal [`Beatmap`]
+    /// with difficulty attributes, i.e. if [`AnyPP::attributes`]
+    /// or [`AnyPP::generate_state`] was called.
     #[inline]
     pub fn try_mode(self, mode: GameMode) -> Option<Self> {
         match self {