Skip to content

Commit 1b464ae

Browse files
committed
Improve rustdocs on error type
Improve rustdocs on `Error` by doing: - Document the reason we use unconventional enum variant identifiers. - Use a live link to `shared-libraries.md` in the Bitcoin Core repo - Use angle brackets on link
1 parent 2bbfc28 commit 1b464ae

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/lib.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ use core::fmt;
1111

1212
use crate::types::*;
1313

14-
/// Errors returned by `libbitcoinconsensus` (see github.com/bitcoin/bitcoin/doc/shared-libraries.md).
14+
/// Errors returned by [`libbitcoinconsensus`].
15+
///
16+
/// The error variant identifiers mimic those from `libbitcoinconsensus`.
17+
///
18+
/// [`libbitcoinconsensus`]: <https://github.com/bitcoin/bitcoin/blob/master/doc/shared-libraries.md#errors>
1519
#[allow(non_camel_case_types)]
1620
#[derive(Debug)]
1721
#[repr(C)]

0 commit comments

Comments
 (0)