Skip to content

Commit

Permalink
improve doc-comments
Browse files Browse the repository at this point in the history
  • Loading branch information
johann-cm committed Jan 15, 2024
1 parent fa95905 commit bd51166
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/logspace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ impl<F> ExactSizeIterator for Logspace<F> where Logspace<F>: Iterator {}

/// An iterator of a sequence of logarithmically spaced numbers.
///
/// The `Logspace` has `n` elements, where the first element is `base.powf(a)`
/// The [`Logspace`] has `n` elements, where the first element is `base.powf(a)`
/// and the last element is `base.powf(b)`. If `base` is negative, this
/// iterator will return all negative values.
///
/// The iterator element type is `F`, where `F` must implement `Float`, e.g.
/// `f32` or `f64`.
/// The iterator element type is `F`, where `F` must implement [`Float`], e.g.
/// [`f32`] or [`f64`].
///
/// **Panics** if converting `n - 1` to type `F` fails.
#[inline]
Expand Down

0 comments on commit bd51166

Please sign in to comment.