search

zaeleus / noodles

Bioinformatics I/O libraries in Rust
MIT License
477 stars 53 forks source link

Docs typo #252

Closed Crispy13 closed 4 months ago

Crispy13 commented 4 months ago

In https://docs.rs/noodles/latest/noodles/bam/index.html,

use noodles_bam as bam;

May it need to be modified to use noodles::bam as bam;?

zaeleus commented 4 months ago

This is not an error. When using the noodles meta crate, you would indeed import using the re-exported names, e.g., noodles::bam. The examples, however, are written with respect to their individual crates, e.g., if you added noodles_bam directly as a dependency.

It's recommended to use the meta crate as described in the README.

Crispy13 commented 4 months ago

Ah, I see.