Skip to content

Commit bac15bb

Browse files
committed
Merge #554: Fix hierarchy of headers on docs landing page
364ad95 Fix hierarchy of headers on docs landing page (thunderbiscuit) Pull request description: ### Description This PR fixes the hierarchy of headers on the lib.rs docs. I noticed it as I was reading through the docs. The new hierarchy is the following: - About (h1) - A tour of BDK (h1) - Examples (h1) - Sync the balance of a descriptor (h2) - Generate a few addresses (h2) - Create a transaction (h2) - Sign a transaction (h2) - Feature flags (h1) - Internal features (h1) ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: rajarshimaitra: tACK 364ad95 Tree-SHA512: b4439a200c320a1815c572ac36b81c4d684209cb5cf1b90d3f761893ad672a270722be7d7b61d77434a7f98c4276d6fc9694d0c86cacf03c72dc35ca17b5e7d3
2 parents 06b80fd + 364ad95 commit bac15bb

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

src/lib.rs

+3-5
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,13 @@
4646
//! ```toml
4747
//! bdk = "0.17.0"
4848
//! ```
49+
//!
50+
//! # Examples
4951
#![cfg_attr(
5052
feature = "electrum",
5153
doc = r##"
5254
## Sync the balance of a descriptor
5355
54-
### Example
5556
```no_run
5657
use bdk::{Wallet, SyncOptions};
5758
use bdk::database::MemoryDatabase;
@@ -80,7 +81,6 @@ fn main() -> Result<(), bdk::Error> {
8081
//!
8182
//! ## Generate a few addresses
8283
//!
83-
//! ### Example
8484
//! ```
8585
//! use bdk::{Wallet};
8686
//! use bdk::database::MemoryDatabase;
@@ -106,7 +106,6 @@ fn main() -> Result<(), bdk::Error> {
106106
doc = r##"
107107
## Create a transaction
108108
109-
### Example
110109
```no_run
111110
use bdk::{FeeRate, Wallet, SyncOptions};
112111
use bdk::database::MemoryDatabase;
@@ -150,7 +149,6 @@ fn main() -> Result<(), bdk::Error> {
150149
//!
151150
//! ## Sign a transaction
152151
//!
153-
//! ### Example
154152
//! ```no_run
155153
//! use std::str::FromStr;
156154
//!
@@ -192,7 +190,7 @@ fn main() -> Result<(), bdk::Error> {
192190
//! * `async-interface`: async functions in bdk traits
193191
//! * `keys-bip39`: [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic codes for generating deterministic keys
194192
//!
195-
//! ## Internal features
193+
//! # Internal features
196194
//!
197195
//! These features do not expose any new API, but influence internal implementation aspects of
198196
//! BDK.

0 commit comments

Comments
 (0)