Skip to content

Commit 8f05e3a

Browse files
committed
Restructure top-level documentation.
1 parent d2f62c7 commit 8f05e3a

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

src/lib.rs

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,19 @@
33
//! `dabuild` simplifies the access to genome build metadata, including its accession, version,
44
//! and contigs.
55
//!
6-
//! ## Examples
6+
//! We list the most common use cases below.
77
//!
8-
//! ### Load genome build
8+
//! ## Load genome build
99
//!
1010
//! The [`builds`] module provides several bundled genome builds.
1111
//! Alternatively, you can load a genome build from a Genome Reference Consortium's (GRC) assembly report.
1212
//!
1313
//! See the [`builds`] documentation for more info.
1414
//!
15-
//! ### Use genome build
15+
//! ## Use genome build
1616
//!
1717
//! Genome build is basically a data container and the usage involves accessing the data.
1818
//!
19-
//! ## Examples
20-
//!
2119
//! We show several examples with the *GRCh38.p13* genome build.
2220
//!
2321
//! ```rust
@@ -27,7 +25,7 @@
2725
//! let build: GenomeBuild = get_grch38_p13();
2826
//! ```
2927
//!
30-
//! ### Check build identifiers
28+
//! ## Check build identifiers
3129
//!
3230
//! We can check the major assembly and the patch of the build:
3331
//!
@@ -39,7 +37,7 @@
3937
//! assert_eq!(build.id().patch(), Some("p13"));
4038
//! ```
4139
//!
42-
//! ### Access contigs
40+
//! ## Access contigs
4341
//!
4442
//! The genome build contains one or more contigs.
4543
//!

0 commit comments

Comments
 (0)