Skip to content

Commit 589115e

Browse files
committed
doc: update docs for now explicit download feature
1 parent c51b9f7 commit 589115e

File tree

3 files changed

+3
-5
lines changed

3 files changed

+3
-5
lines changed

node/CHANGELOG.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
# 0.7.0 2025-04-04
66

77
- Retry initial client connections [#111](https://github.com/rust-bitcoin/corepc/pull/111)
8-
-
98

109
# 0.6.1 - 2025-03-11
1110

node/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
Utility to run a regtest bitcoind process, useful in integration testing environment.
44

5-
When the auto-download feature is selected by activating one of the version feature, such as `25_1`
6-
for bitcoin core 25.1, starting a regtest node is as simple as that:
5+
When the auto-download feature is enabled, starting a regtest node is as simple as that:
76

87
```rust
9-
// the download feature is enabled whenever a specific version is enabled, for example `25_1` or `24_0_1`
8+
// the download feature must be enabled with a specific version, for example `25_1` or `24_0_1`
109
#[cfg(feature = "download")]
1110
{
1211
let node = corepc_node::Node::from_downloaded().unwrap();

node/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ pub fn downloaded_exe_path() -> anyhow::Result<String> {
562562
/// Returns the daemon `bitcoind` executable with the following precedence:
563563
///
564564
/// 1) If it's specified in the `BITCOIND_EXE` env var
565-
/// 2) If there is no env var but an auto-download feature such as `23_1` is enabled, returns the
565+
/// 2) If there is no env var but the auto-download feature is enabled, returns the
566566
/// path of the downloaded executabled
567567
/// 3) If neither of the precedent are available, the `bitcoind` executable is searched in the `PATH`
568568
pub fn exe_path() -> anyhow::Result<String> {

0 commit comments

Comments
 (0)