Skip to content

Commit

Permalink
doc: fix intra-doc links (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxOhn authored Dec 30, 2023
1 parent ec7ff74 commit bf78758
Show file tree
Hide file tree
Showing 11 changed files with 60 additions and 32 deletions.
9 changes: 6 additions & 3 deletions src/catch/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,12 @@ impl<'map> CatchStars<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the difficulty after every few objects, instead of
/// using [`CatchStars`] multiple times with different `passed_objects`, you should use
/// [`CatchGradualDifficultyAttributes`](crate::catch::CatchGradualDifficulty).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the difficulty after every few objects, instead of
using [`CatchStars`] multiple times with different `passed_objects`, you should use
[`CatchGradualDifficultyAttributes`](crate::catch::CatchGradualDifficulty)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/catch/pp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,12 @@ impl<'map> CatchPP<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the performance after every few objects, instead of
/// using [`CatchPP`] multiple times with different `passed_objects`, you should use
/// [`CatchGradualPerformanceAttributes`](crate::catch::CatchGradualPerformance).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the performance after every few objects, instead of
using [`CatchPP`] multiple times with different `passed_objects`, you should use
[`CatchGradualPerformanceAttributes`](crate::catch::CatchGradualPerformance)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/mania/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,12 @@ impl<'map> ManiaStars<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the difficulty after every few objects, instead of
/// using [`ManiaStars`] multiple times with different `passed_objects`, you should use
/// [`ManiaGradualDifficultyAttributes`](crate::mania::ManiaGradualDifficulty).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the difficulty after every few objects, instead of
using [`ManiaStars`] multiple times with different `passed_objects`, you should use
[`ManiaGradualDifficultyAttributes`](crate::mania::ManiaGradualDifficulty)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/mania/pp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,12 @@ impl<'map> ManiaPP<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the performance after every few objects, instead of
/// using [`ManiaPP`] multiple times with different `passed_objects`, you should use
/// [`ManiaGradualPerformanceAttributes`](crate::mania::ManiaGradualPerformance).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the performance after every few objects, instead of
using [`ManiaPP`] multiple times with different `passed_objects`, you should use
[`ManiaGradualPerformanceAttributes`](crate::mania::ManiaGradualPerformance)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/osu/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,12 @@ impl<'map> OsuStars<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the difficulty after every few objects, instead of
/// using [`OsuStars`] multiple times with different `passed_objects`, you should use
/// [`OsuGradualDifficulty`].
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the difficulty after every few objects, instead of
using [`OsuStars`] multiple times with different `passed_objects`, you should use
[`OsuGradualDifficulty`]."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/osu/pp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,12 @@ impl<'map> OsuPP<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the performance after every few objects, instead of
/// using [`OsuPP`] multiple times with different `passed_objects`, you should use
/// [`OsuGradualPerformanceAttributes`](crate::osu::OsuGradualPerformance).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the performance after every few objects, instead of
using [`OsuPP`] multiple times with different `passed_objects`, you should use
[`OsuGradualPerformanceAttributes`](crate::osu::OsuGradualPerformance)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/pp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,12 @@ impl<'map> AnyPP<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the performance after every few objects, instead of
/// using [`AnyPP`] multiple times with different `passed_objects`, you should use
/// [`GradualPerformanceAttributes`](crate::GradualPerformance).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the performance after every few objects, instead of
using [`AnyPP`] multiple times with different `passed_objects`, you should use
[`GradualPerformanceAttributes`](crate::GradualPerformance)."
)]
#[inline]
pub fn passed_objects(self, passed_objects: usize) -> Self {
match self {
Expand Down
2 changes: 0 additions & 2 deletions src/score_state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ use crate::{
/// Aggregation for a score's current state i.e. what is
/// the maximum combo so far, what are the current
/// hitresults and what is the current score.
///
/// This struct is used for [`GradualPerformance`](crate::GradualPerformance).
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct ScoreState {
/// Maximum combo that the score has had so far.
Expand Down
9 changes: 6 additions & 3 deletions src/stars.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,12 @@ impl<'map> AnyStars<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the performance after every few objects, instead of
/// using [`AnyStars`] multiple times with different `passed_objects`, you should use
/// [`GradualDifficultyAttributes`](crate::GradualDifficulty).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the performance after every few objects, instead of
using [`AnyStars`] multiple times with different `passed_objects`, you should use
[`GradualDifficultyAttributes`](crate::GradualDifficulty)."
)]
#[inline]
pub fn passed_objects(self, passed_objects: usize) -> Self {
match self {
Expand Down
9 changes: 6 additions & 3 deletions src/taiko/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,12 @@ impl<'map> TaikoStars<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the difficulty after every few objects, instead of
/// using [`TaikoStars`] multiple times with different `passed_objects`, you should use
/// [`TaikoGradualDifficultyAttributes`](crate::taiko::TaikoGradualDifficulty).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the difficulty after every few objects, instead of
using [`TaikoStars`] multiple times with different `passed_objects`, you should use
[`TaikoGradualDifficultyAttributes`](crate::taiko::TaikoGradualDifficulty)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down
9 changes: 6 additions & 3 deletions src/taiko/pp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,12 @@ impl<'map> TaikoPP<'map> {

/// Amount of passed objects for partial plays, e.g. a fail.
///
/// If you want to calculate the performance after every few objects, instead of
/// using [`TaikoPP`] multiple times with different `passed_objects`, you should use
/// [`TaikoGradualPerformanceAttributes`](crate::taiko::TaikoGradualPerformance).
#[cfg_attr(
feature = "gradual",
doc = "If you want to calculate the performance after every few objects, instead of
using [`TaikoPP`] multiple times with different `passed_objects`, you should use
[`TaikoGradualPerformanceAttributes`](crate::taiko::TaikoGradualPerformance)."
)]
#[inline]
pub fn passed_objects(mut self, passed_objects: usize) -> Self {
self.passed_objects = Some(passed_objects);
Expand Down

0 comments on commit bf78758

Please sign in to comment.