Skip to content

Commit

Permalink
Doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
mobiusklein committed Nov 26, 2023
1 parent 9f3d8dc commit afcec45
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
5 changes: 3 additions & 2 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ use std::collections::HashMap;
use std::thread;
use std::sync::mpsc::sync_channel;

#[cfg(feature = "mzmlb")]
use mzdata::io::mzmlb;

use mzdata::prelude::*;
use mzdata::io::{mgf, mzml, offset_index, ScanSource};
#[cfg(feature = "mzmlb")]
use mzdata::io::mzmlb;
use mzdata::spectrum::SignalContinuity;
use mzdata::spectrum::{DeconvolutedSpectrum, MultiLayerSpectrum, PeakDataLevel, SpectrumBehavior};
use mzpeaks::PeakCollection;
Expand Down
1 change: 1 addition & 0 deletions src/prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ pub use crate::io::traits::{
pub use crate::meta::MSDataFileMetadata;
pub use crate::params::{ParamDescribed, ParamLike};
pub use crate::spectrum::{IonProperties, PrecursorSelection, SpectrumBehavior};
pub use crate::spectrum::signal::{ByteArrayView, ByteArrayViewMut, BuildArrayMapFrom, BuildFromArrayMap};
pub use std::convert::TryInto;
pub use std::io::prelude::*;
4 changes: 2 additions & 2 deletions src/spectrum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ itself, plus all the metadata that describes how that data was acquired by
the instrument.
# Components
- [`signal`](crate::spectrum::signal) includes structures for dealing with raw signal data arrays that may or may not
- [`signal`] includes structures for dealing with raw signal data arrays that may or may not
be byte-encoded but not strongly typed, though it does not include signal processing as that is outside the scope of
this crate.
Expand All @@ -32,7 +32,7 @@ The [`SpectrumBehavior`] trait is included in the crate prelude, and gives the c
read-only access to components that describe a spectrum's metadata, and
```rust
use std::fs::File;
use mzdata::io::prelude::*;
use mzdata::prelude::*;
use mzpeaks::{Tolerance, prelude::*};
use mzdata::io::MzMLReader;
use mzdata::spectrum::{SignalContinuity};
Expand Down
2 changes: 1 addition & 1 deletion src/spectrum/spectrum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The [`SpectrumBehavior`] trait is included in the crate prelude, and gives the c
read-only access to components that describe a spectrum's metadata, and
```rust
use std::fs::File;
use mzdata::io::prelude::*;
use mzdata::prelude::*;
use mzpeaks::{Tolerance, prelude::*};
use mzdata::io::MzMLReader;
use mzdata::spectrum::{SignalContinuity};
Expand Down

0 comments on commit afcec45

Please sign in to comment.