Skip to content

Commit 66e7cbd

Browse files
committed
f - Clarify RestClient::new documentation
1 parent ac3c136 commit 66e7cbd

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

lightning-block-sync/src/rest.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ pub struct RestClient {
1616

1717
impl RestClient {
1818
/// Creates a new REST client connected to the given endpoint.
19+
///
20+
/// The endpoint should contain the REST path component (e.g., http://127.0.0.1:8332/rest).
1921
pub fn new(endpoint: HttpEndpoint) -> std::io::Result<Self> {
2022
let client = HttpClient::connect(&endpoint)?;
2123
Ok(Self { endpoint, client })

0 commit comments

Comments
 (0)