Skip to content

Commit 5ffcf0f

Browse files
authored
Merge pull request #102 from TheCharlatan/chaintype_docs
Tweak ChainType docs a bit
2 parents 5b69a6a + 5bb904b commit 5ffcf0f

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

src/state/context.rs

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,6 @@ impl ContextBuilder {
428428
/// Sets the Bitcoin network chain type.
429429
///
430430
/// Configures the context to operate on the specified Bitcoin network.
431-
/// Each chain type has different consensus rules and network parameters.
432431
///
433432
/// # Arguments
434433
/// * `chain_type` - The [`ChainType`] to configure (mainnet, testnet, etc.)
@@ -470,7 +469,7 @@ impl ContextBuilder {
470469
///
471470
/// # Example
472471
/// ```no_run
473-
/// use bitcoinkernel::{ContextBuilder, ChainType, KernelError};
472+
/// use bitcoinkernel::{ContextBuilder, KernelError};
474473
///
475474
/// let context = ContextBuilder::new()
476475
/// .with_block_tip_notification(|_state, hash, progress| {
@@ -979,10 +978,10 @@ impl Drop for ContextBuilder {
979978
/// Each chain type has different consensus rules and network parameters.
980979
///
981980
/// # Variants
982-
/// * [`Mainnet`](ChainType::Mainnet) - Bitcoin mainnet, the production network with economic value
983-
/// * [`Testnet`](ChainType::Testnet) - The original test network for development and testing
984-
/// * [`Testnet4`](ChainType::Testnet4) - The newer test network with improved features
985-
/// * [`Signet`](ChainType::Signet) - Signed test network with controlled block production
981+
/// * [`Mainnet`](ChainType::Mainnet) - Production network with economic value
982+
/// * [`Testnet`](ChainType::Testnet) - Test network for development and testing
983+
/// * [`Testnet4`](ChainType::Testnet4) - Newer test network with tweaked block production
984+
/// * [`Signet`](ChainType::Signet) - Test network with controlled, regular block production
986985
/// * [`Regtest`](ChainType::Regtest) - Regression test network for local development
987986
///
988987
/// # Examples
@@ -1003,13 +1002,13 @@ impl Drop for ContextBuilder {
10031002
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
10041003
#[repr(u8)]
10051004
pub enum ChainType {
1006-
/// Bitcoin mainnet - the production network with economic value
1005+
/// Bitcoin mainnet - production network with economic value
10071006
Mainnet = BTCK_CHAIN_TYPE_MAINNET,
1008-
/// Bitcoin testnet - the original test network for development and testing
1007+
/// Bitcoin testnet3 - test network for development and testing
10091008
Testnet = BTCK_CHAIN_TYPE_TESTNET,
1010-
/// Bitcoin testnet4 - the newer test network with improved features
1009+
/// Bitcoin testnet4 - newer test network with tweaked block production
10111010
Testnet4 = BTCK_CHAIN_TYPE_TESTNET_4,
1012-
/// Bitcoin signet - signed test network with controlled block production
1011+
/// Bitcoin signet - test network with controlled, regular block production
10131012
Signet = BTCK_CHAIN_TYPE_SIGNET,
10141013
/// Regression test network for local development
10151014
Regtest = BTCK_CHAIN_TYPE_REGTEST,

0 commit comments

Comments
 (0)