From e3f6d23b491da8b55fb16e887251af5b56fbeec9 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 17 Nov 2022 09:42:22 +1100 Subject: [PATCH 1/2] Fix incorrect method name in docs We are currently not checking for broken doc links in CI. Recently we removed a bunch of deprecated functions, one of which was still referred to in rustdocs. Fix the docs to use the correct new method name. --- src/key.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/key.rs b/src/key.rs index 836dcec..e6c50e1 100644 --- a/src/key.rs +++ b/src/key.rs @@ -1304,10 +1304,10 @@ impl XOnlyPublicKey { } } - /// Verifies that a tweak produced by [`XOnlyPublicKey::tweak_add_assign`] was computed correctly. + /// Verifies that a tweak produced by [`XOnlyPublicKey::add_tweak`] was computed correctly. /// /// Should be called on the original untweaked key. Takes the tweaked key and output parity from - /// [`XOnlyPublicKey::tweak_add_assign`] as input. + /// [`XOnlyPublicKey::add_tweak`] as input. /// /// Currently this is not much more efficient than just recomputing the tweak and checking /// equality. However, in future this API will support batch verification, which is From ade888e92287efa6561d49eb06f6c92ecef711b5 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 17 Nov 2022 09:45:21 +1100 Subject: [PATCH 2/2] Check for broken links in CI Add `-- -D rustdoc::broken-intra-doc-links` to the docs build in CI to check for broken links. In order to use this flag use `cargo rustdoc` instead of `cargo doc`. --- contrib/test.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/test.sh b/contrib/test.sh index 950ad1c..d2a0f38 100755 --- a/contrib/test.sh +++ b/contrib/test.sh @@ -64,7 +64,7 @@ fi # Build the docs if told to (this only works with the nightly toolchain) if [ "$DO_DOCS" = true ]; then - RUSTDOCFLAGS="--cfg docsrs" cargo doc --all --features="$FEATURES" + RUSTDOCFLAGS="--cfg docsrs" cargo rustdoc --features="$FEATURES" -- -D rustdoc::broken-intra-doc-links fi # Webassembly stuff