Skip to content

Commit

Permalink
Merge pull request #53 from andrewcsmith/fix-doc-links-and-root-descr…
Browse files Browse the repository at this point in the history
…iptions

Fix doc links and root descriptions
  • Loading branch information
mitchmindtree authored Jun 27, 2017
2 parents 9c4e954 + e762737 commit 0e00a97
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/frame.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Use the [**Frame**](./trait.Frame.html) trait to remain generic over the number of channels at
//! Use the Frame trait to remain generic over the number of channels at
//! a single discrete moment in time.
//!
//! Implementations are provided for all fixed-size arrays up to 32 elements in length.
Expand Down
2 changes: 2 additions & 0 deletions src/interpolate.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! The Interpolate module allows for conversion between various sample rates.
use {Duplex, Frame, Sample, VecDeque};
use core::f64::consts::PI;
use ops::f64::{sin, cos};
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
//! - Use the [**slice** module](./slice/index.html) for working with slices of **Samples** and **Frames**.
//! - See the [**conv** module](./conv/index.html) for fast conversions between slices, frames and samples.
//! - See the [**types** module](./types/index.html) for provided custom sample types.
//! - See the [**rate** module](./rate/index.html) for sample rate conversion and scaling.
//! - See the [**interpolate** module](./interpolate/index.html) for sample rate conversion and scaling.
#![recursion_limit="512"]
#![cfg_attr(not(feature = "std"), no_std)]
Expand Down
6 changes: 3 additions & 3 deletions src/signal.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Use the [**Signal** trait](./trait.Signal.html) for working with **Iterator**s that yield
//! **Frame**s. To complement the **Iterator** trait, **Signal** provides methods for adding,
//! scaling, offsetting, multiplying, clipping and generating frame iterators and more.
//! Use the **Signal** trait for working with **Iterator**s that yield **Frame**s. To complement
//! the **Iterator** trait, **Signal** provides methods for adding, scaling, offsetting,
//! multiplying, clipping and generating frame iterators and more.
//!
//! You may also find a series of **Signal** source functions, including:
//!
Expand Down
3 changes: 3 additions & 0 deletions src/window.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
//! Module for windowing over a batch of Frames. Includes default Hanning and Rectangle window
//! types.
use {FloatSample, Sample};
use core;
use core::marker::PhantomData;
Expand Down

0 comments on commit 0e00a97

Please sign in to comment.