docs & clippy adjustment

This commit is contained in:
MaxOhn
2021-04-17 16:38:12 +02:00
parent 3f81f18c75
commit 17426b9975
12 changed files with 26 additions and 21 deletions
+1 -4
View File
@@ -29,6 +29,7 @@ use crate::{Beatmap, Mods, PpResult, StarResult};
/// println!("PP: {} | Stars: {}", next_result.pp(), next_result.stars());
/// ```
#[derive(Clone, Debug)]
#[allow(clippy::upper_case_acronyms)]
pub struct OsuPP<'m> {
map: &'m Beatmap,
attributes: Option<DifficultyAttributes>,
@@ -261,10 +262,6 @@ impl<'m> OsuPP<'m> {
unreachable!()
}
/// Returns an object which contains the pp and [`DifficultyAttributes`](crate::osu::DifficultyAttributes)
/// containing stars and other attributes.
///
/// `stars_func` will be used to calculate the difficulty attributes if they are not yet given.
fn calculate_with_func(
mut self,
stars_func: impl FnOnce(&Beatmap, u32, Option<usize>) -> StarResult,
+2 -1
View File
@@ -1,6 +1,7 @@
//! The positional offset of notes created by stack leniency is not considered.
//! This means the jump distance inbetween notes might be slightly off, resulting in small inaccuracies.
//! Since calculating these offsets is relatively expensive though, this version is faster than `all_included`.
//! Since calculating these offsets is relatively expensive though,
//! this version is generally faster than `all_included`.
#![cfg(feature = "no_leniency")]
@@ -1,6 +1,6 @@
//! In addtion to not considering the positional offset caused by stack leniency, slider paths are also ignored.
//! This means the travel distance of notes is completely omitted which may cause further inaccuracies.
//! Since the slider paths don't have to be computed though, it should generally be faster than `no_leniency`.
//! Since the slider paths don't have to be computed though, it is generally faster than `no_leniency`.
#![cfg(feature = "no_sliders_no_leniency")]