Skip to content

Commit 55298d1

Browse files
committed
Standardize version format in docs
There is a variation in the way the version number is written in the docs. Some are preceded by a 0 and some arn't. Core states the versions up to and including 21 with preceding 0, and for 22 and above without. Change all version numbers in the text to be v0.17 - v0.21, and v22 - v29 to match core.
1 parent 37510f9 commit 55298d1

File tree

22 files changed

+38
-38
lines changed

22 files changed

+38
-38
lines changed

client/src/client_sync/v21/wallet.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Macros for implementing JSON-RPC methods on a client.
44
//!
55
//! Specifically this is methods found under the `== Wallet ==` section of the
6-
//! API docs of Bitcoin Core `v21`.
6+
//! API docs of Bitcoin Core `v0.21`.
77
//!
88
//! All macros require `Client` to be in scope.
99
//!

client/src/client_sync/v23/blockchain.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Macros for implementing JSON-RPC methods on a client.
44
//!
55
//! Specifically this is methods found under the `== Blockchain ==` section of the
6-
//! API docs of Bitcoin Core `v0.23`.
6+
//! API docs of Bitcoin Core `v23`.
77
//!
88
//! All macros require `Client` to be in scope.
99
//!

client/src/client_sync/v26/blockchain.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Macros for implementing JSON-RPC methods on a client.
44
//!
55
//! Specifically this is methods found under the `== Blockchain ==` section of the
6-
//! API docs of Bitcoin Core `v0.26`.
6+
//! API docs of Bitcoin Core `v26`.
77
//!
88
//! All macros require `Client` to be in scope.
99
//!

client/src/client_sync/v26/mining.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Macros for implementing JSON-RPC methods on a client.
44
//!
55
//! Specifically this is methods found under the `== Mining ==` section of the
6-
//! API docs of Bitcoin Core `v0.26`.
6+
//! API docs of Bitcoin Core `v26`.
77
//!
88
//! All macros require `Client` to be in scope.
99
//!

integration_test/tests/generating.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use node::vtype::*; // All the version specific types.
99
use node::mtype;
1010

1111
#[test]
12-
// The `generate` method was deprecated in Core v18 and was removed in v19.
12+
// The `generate` method was deprecated in Core v0.18 and was removed in v0.19.
1313
#[cfg(feature = "v17")]
1414
fn generating__generate__modelled() {
1515
const NBLOCKS: usize = 10;

integration_test/tests/mining.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,4 +211,4 @@ fn mining__submit_block_with_dummy_coinbase(node: &Node, bt: &mtype::GetBlockTem
211211
let _ = node.client.submit_block(&block).expect("submitblock");
212212
}
213213

214-
// TODO: submitheader "hexdata" (v18 onwards)
214+
// TODO: submitheader "hexdata" (v0.18 onwards)

integration_test/tests/raw_transactions.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use node::{mtype, Input, Output};
1313
use node::vtype::*; // All the version specific types.
1414

1515
#[test]
16-
#[cfg(not(feature = "v17"))] // analyzepsbt was added in v18.
16+
#[cfg(not(feature = "v17"))] // analyzepsbt was added in v0.18.
1717
fn raw_transactions__analyze_psbt__modelled() {
1818
let node = Node::with_wallet(Wallet::Default, &[]);
1919
node.fund_wallet();
@@ -427,7 +427,7 @@ fn raw_transactions__submit_package__modelled() {
427427
fn raw_transactions__test_mempool_accept__modelled() {}
428428

429429
#[test]
430-
#[cfg(not(feature = "v17"))] // utxoupdatepsbt was added in v18.
430+
#[cfg(not(feature = "v17"))] // utxoupdatepsbt was added in v0.18.
431431
fn raw_transactions__utxo_update_psbt() {}
432432

433433
// Manipulates raw transactions.
@@ -487,7 +487,7 @@ fn create_sign_send(node: &Node) {
487487
//
488488
// Calls the following RPC methods:
489489
// - create_raw_transaction
490-
// - sign_raw_transaction_with_key (sign_raw_transaction was deprecated in v17).
490+
// - sign_raw_transaction_with_key (sign_raw_transaction was deprecated in v0.17).
491491
// - send_raw_transaction
492492
//
493493
// TODO: Work out how to get a private key without using `dumpprivkey`.
@@ -544,7 +544,7 @@ fn create_sign_with_key_send(node: &Node) {
544544
//
545545
// Calls the following RPC methods:
546546
// - fund_raw_transaction
547-
// - sign_raw_transaction_with_wallet (sign_raw_transaction was deprecated in v17).
547+
// - sign_raw_transaction_with_wallet (sign_raw_transaction was deprecated in v0.17).
548548
// - send_raw_transaction
549549
fn create_fund_sign_send(node: &Node) {
550550
let (_addr, _tx, txid, _tx_out, vout) = create_utxo(node);

types/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ pub fn compact_size_decode(slice: &mut &[u8]) -> u64 {
177177
///
178178
/// This is used by methods in the blockchain section and in the raw transaction section (i.e raw
179179
/// transaction and psbt methods). The shape changed in Core v22 but the new shape is fully
180-
/// backwards compatible so we only provide it not a v17 specific type. The `mtype::ScriptPubkey`
180+
/// backwards compatible so we only provide it not a v0.17 specific type. The `mtype::ScriptPubkey`
181181
/// mirrors this design (but with concrete `rust-bitcoin` types).
182182
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
183183
pub struct ScriptPubkey {

types/src/model/blockchain.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,15 +407,15 @@ pub struct MempoolEntry {
407407
pub ancestor_size: u32,
408408
/// Hash of serialized transaction, including witness data.
409409
pub wtxid: Wtxid,
410-
/// (No docs in Core v17.)
410+
/// (No docs in Core v0.17.)
411411
pub fees: MempoolEntryFees,
412412
/// Unconfirmed transactions used as inputs for this transaction (parent transaction id).
413413
pub depends: Vec<Txid>,
414414
/// Unconfirmed transactions spending outputs from this transaction (child transaction id).
415415
pub spent_by: Vec<Txid>,
416416
}
417417

418-
/// (No docs in Core v17.)
418+
/// (No docs in Core v0.17.)
419419
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
420420
pub struct MempoolEntryFees {
421421
/// Transaction fee in BTC.

types/src/psbt/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ pub struct Bip32Deriv {
196196
}
197197

198198
/// The key source data for a BIP-32 derivation.
199-
// In v17 the BIP-32 derivation for inputs is a map of pubkey to this type.
199+
// In v0.17 the BIP-32 derivation for inputs is a map of pubkey to this type.
200200
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
201201
pub struct InputKeySource {
202202
/// The fingerprint of the master key.

0 commit comments

Comments
 (0)