Skip to content

Commit

Permalink
doc: Fixing warning during cargo doc site compilation (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
dandxy89 committed Nov 11, 2023
1 parent 909394b commit 9ebd101
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions src/indicators/example.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use serde::{Deserialize, Serialize};

/// # Example config for the indicator **Configuration**
///
/// Must implement `Debug`, `Clone`, `Default`, [`IndicatorConfig`](crate::core::IndicatorConfig) trait.
/// Must implement `Debug`, `Clone`, `Default`, [`IndicatorConfig`] trait.
///
/// Also it may implements `serde::{Serialize, Deserialize}` - it's up to you.
///
Expand Down Expand Up @@ -89,9 +89,9 @@ impl Default for Example {
}
}

/// # Example [`IndicatorInstance`](crate::core::IndicatorInstance) implementation
/// # Example [`IndicatorInstance`] implementation
///
/// Must implement `Debug` and [`IndicatorInstance`](crate::core::IndicatorInstance) traits
/// Must implement `Debug` and [`IndicatorInstance`] traits
///
/// See source code for the full example
#[derive(Debug, Clone, Copy)]
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ limitations under the License.

//! Yet Another Technical Analysis library
//!
//! `YaTa` implements most common technical analysis [methods](crate::methods) and [indicators](crate::indicators)
//! `YaTa` implements most common technical analysis [methods] and [indicators]
//!
//! It also provides you an interface to create your own indicators.
//!
Expand Down
2 changes: 1 addition & 1 deletion src/methods/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ mod tr;
pub use tr::TR;
/// Renko implementation entities
///
/// For more information see [`Renko`](crate::methods::Renko)
/// For more information see [`Renko`]
pub mod renko;
#[doc(inline)]
pub use renko::Renko;
Expand Down
6 changes: 3 additions & 3 deletions src/methods/renko.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ use serde::{Deserialize, Serialize};
///
/// * [`RenkoOutput`] which is `Renko`'s method output type.
///
/// It implements an [`Iterator`](std::iter::Iterator) trait for generating [`RenkoBlock`]s after each step of calling [`Method::next`] on [`Renko`].
/// It implements an [`Iterator`] trait for generating [`RenkoBlock`]s after each step of calling [`Method::next`] on [`Renko`].
/// `RenkoOutput` may produce any amount of `RenkoBlock`s or may not produce it at all.
///
/// * [`RenkoBlock`] is final entity of Renko chart.
///
/// It has `open` and `close` values which are similar to corresponding [`OHLCV`](crate::core::OHLCV)'s values.
/// It has `open` and `close` values which are similar to corresponding [`OHLCV`]'s values.
///
/// So the final workflow is like that:
///
Expand Down Expand Up @@ -168,7 +168,7 @@ impl OHLCV for RenkoBlock {
}
/// [`Renko`]'s method [output type](crate::core::Method::Output)
///
/// Implements [`Iterator`](std::iter::Iterator) trait for generating [`RenkoBlock`]s.
/// Implements [`Iterator`] trait for generating [`RenkoBlock`]s.
#[derive(Debug, Clone)]
#[allow(missing_copy_implementations)]
pub struct RenkoOutput {
Expand Down

0 comments on commit 9ebd101

Please sign in to comment.