docs: fix unresolved and private intra-doc links (#78)
A full `cargo doc --workspace` (and docs.rs, which builds with `-D rustdoc::all`) emitted five broken intra-doc links. docs.rs treats these as hard errors, so any 0.2.x doc build was at risk of aborting. - mama.rs: `[`Fama`]` -> `[`crate::Fama`]` (Fama lives in another module) - standard_error.rs: `[`crate::Bollinger`]` -> `[`crate::BollingerBands`]` (the public type is `BollingerBands`, not `Bollinger`) - aggregator.rs: drop the link to the private `OpenBar::into_candle`, keep it as plain code text - resample.rs: drop the link to the private `RolledBar::into_candle` - csv.rs: `CandleReader::with_timestamp_parser` never existed; reword to state plainly that ISO/RFC timestamps must be converted to integers Verified with `RUSTDOCFLAGS="-D rustdoc::broken_intra_doc_links \ -D rustdoc::private_intra_doc_links" cargo doc --workspace --no-deps`: clean, zero warnings.
This commit is contained in:
@@ -32,7 +32,7 @@ pub struct MamaOutput {
|
|||||||
/// + fama_prev * (1 - 0.5 * fast_limit)`, lagging MAMA so crossovers signal
|
/// + fama_prev * (1 - 0.5 * fast_limit)`, lagging MAMA so crossovers signal
|
||||||
/// trend reversals.
|
/// trend reversals.
|
||||||
///
|
///
|
||||||
/// The indicator emits both lines as a [`MamaOutput`]. Use the [`Fama`] wrapper
|
/// The indicator emits both lines as a [`MamaOutput`]. Use the [`crate::Fama`] wrapper
|
||||||
/// in this module to expose just the slow line if needed (e.g. for chaining).
|
/// in this module to expose just the slow line if needed (e.g. for chaining).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ use crate::traits::Indicator;
|
|||||||
/// This is the textbook **standard error of estimate** of OLS: it measures
|
/// This is the textbook **standard error of estimate** of OLS: it measures
|
||||||
/// the typical distance between the observed prices and the fitted line,
|
/// the typical distance between the observed prices and the fitted line,
|
||||||
/// using the residual degrees of freedom `n − 2`. It is the spread that
|
/// using the residual degrees of freedom `n − 2`. It is the spread that
|
||||||
/// drives [`crate::Bollinger`]-style bands around a regression instead of
|
/// drives [`crate::BollingerBands`]-style bands around a regression instead of
|
||||||
/// around an SMA — when the price hugs its trend, `StdErr` is small.
|
/// around an SMA — when the price hugs its trend, `StdErr` is small.
|
||||||
///
|
///
|
||||||
/// Each `update` is O(1): the `Σx` and `Σxx` terms depend only on `period`
|
/// Each `update` is O(1): the `Σx` and `Σxx` terms depend only on `period`
|
||||||
|
|||||||
@@ -346,7 +346,7 @@ impl TickAggregator {
|
|||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
/// Returns an error if the open bar's accumulated volume is non-finite
|
/// Returns an error if the open bar's accumulated volume is non-finite
|
||||||
/// (see [`OpenBar::into_candle`]).
|
/// (see the internal `OpenBar::into_candle`).
|
||||||
pub fn flush(&mut self) -> Result<Option<Candle>> {
|
pub fn flush(&mut self) -> Result<Option<Candle>> {
|
||||||
self.open_bar.take().map(OpenBar::into_candle).transpose()
|
self.open_bar.take().map(OpenBar::into_candle).transpose()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,8 +24,9 @@ const REQUIRED_COLUMNS: [&str; 6] = ["timestamp", "open", "high", "low", "close"
|
|||||||
|
|
||||||
/// Default OHLCV CSV row layout.
|
/// Default OHLCV CSV row layout.
|
||||||
///
|
///
|
||||||
/// The timestamp is parsed as an `i64`; if your file ships an RFC3339 / ISO8601
|
/// The timestamp is parsed as an `i64` (for example a Unix epoch). RFC3339 /
|
||||||
/// string instead, use [`CandleReader::with_timestamp_parser`].
|
/// ISO8601 string timestamps are not handled by this layout; convert them to
|
||||||
|
/// integers before reading.
|
||||||
#[derive(Debug, Clone, Deserialize)]
|
#[derive(Debug, Clone, Deserialize)]
|
||||||
pub struct DefaultRow {
|
pub struct DefaultRow {
|
||||||
pub timestamp: i64,
|
pub timestamp: i64,
|
||||||
|
|||||||
@@ -114,7 +114,7 @@ impl Resampler {
|
|||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
/// Returns an error if the open bar's accumulated volume is non-finite
|
/// Returns an error if the open bar's accumulated volume is non-finite
|
||||||
/// (see [`RolledBar::into_candle`]).
|
/// (see the internal `RolledBar::into_candle`).
|
||||||
pub fn flush(&mut self) -> Result<Option<Candle>> {
|
pub fn flush(&mut self) -> Result<Option<Candle>> {
|
||||||
self.open.take().map(RolledBar::into_candle).transpose()
|
self.open.take().map(RolledBar::into_candle).transpose()
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user