]> Untitled Git - bdk/commitdiff
[ci] Fail 'Build docs' job if warnings
authorSteve Myers <steve@notmandatory.org>
Tue, 5 Jan 2021 00:20:47 +0000 (16:20 -0800)
committerSteve Myers <steve@notmandatory.org>
Tue, 5 Jan 2021 00:39:11 +0000 (16:39 -0800)
.github/workflows/nightly_docs.yml
src/keys/mod.rs

index dd8155cf1c455414e3b3e93d0263250a0ab0ac92..d88593face23dcf8bbdbb13bf44d805915f2030e 100644 (file)
@@ -27,7 +27,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: rustdoc
-          args: --verbose --features=compiler,electrum,esplora,compact_filters,key-value-db,all-keys -- --cfg docsrs
+          args: --verbose --features=compiler,electrum,esplora,compact_filters,key-value-db,all-keys -- --cfg docsrs -Dwarnings
       - name: Upload artifact
         uses: actions/upload-artifact@v2
         with:
index 25c8e03bfb96dbec2bcf3197210eb3cd47646cf4..7a7fb7f0bb23c5bec7d8cfd6fbfd7e6768ae2a78 100644 (file)
@@ -420,7 +420,7 @@ where
 /// [`ToDescriptorKey`]: the generated keys can be directly used in descriptors if `Self` is also
 /// [`ToDescriptorKey`].
 pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
-    /// Type specifying the amount of entropy required e.g. [u8;32]
+    /// Type specifying the amount of entropy required e.g. `[u8;32]`
     type Entropy: AsMut<[u8]> + Default;
 
     /// Extra options required by the `generate_with_entropy`