Skip to content

Commit 90dc766

Browse files
committed
Do trivial cleanup to main lib docs
- Improve rendered headers by removing the empty `# Introduction` section - Add full stops
1 parent e267c78 commit 90dc766

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

src/lib.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
//! Miniscript and Output Descriptors
55
//!
6-
//! # Introduction
76
//! ## Bitcoin Script
87
//!
98
//! In Bitcoin, spending policies are defined and enforced by means of a
@@ -35,7 +34,7 @@
3534
//! While spending policies in Bitcoin are entirely defined by Script; there
3635
//! are multiple ways of embedding these Scripts in transaction outputs; for
3736
//! example, P2SH or Segwit v0. These different embeddings are expressed by
38-
//! *Output Descriptors*, [which are described here](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md)
37+
//! *Output Descriptors*, [which are described here](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md).
3938
//!
4039
//! # Examples
4140
//!
@@ -51,7 +50,7 @@
5150
//! )))\
5251
//! ").unwrap();
5352
//!
54-
//! // Derive the P2SH address
53+
//! // Derive the P2SH address.
5554
//! assert_eq!(
5655
//! desc.address(bitcoin::Network::Bitcoin).unwrap().to_string(),
5756
//! "3CJxbQBfWAe1ZkKiGQNEYrioV73ZwvBWns"
@@ -62,7 +61,7 @@
6261
//! // elements in Wsh scripts or they contain a combination of timelock and heightlock.
6362
//! assert!(desc.sanity_check().is_ok());
6463
//!
65-
//! // Estimate the satisfaction cost
64+
//! // Estimate the satisfaction cost.
6665
//! assert_eq!(desc.max_satisfaction_weight().unwrap(), 293);
6766
//! ```
6867
//!

0 commit comments

Comments
 (0)