Also correct/check links in private item documentation 2021-03-doc-cleanups
authorMatt Corallo <git@bluematt.me>
Wed, 17 Mar 2021 19:56:02 +0000 (15:56 -0400)
committerMatt Corallo <git@bluematt.me>
Thu, 18 Mar 2021 15:28:23 +0000 (11:28 -0400)
ci/check-compiles.sh
lightning/src/ln/channel.rs

index 45ade5c6a1e1d321f3205f0372d9e548af268bbe..9222f609cc082ced5a1ac3806e8c9b05c7531379 100755 (executable)
@@ -4,4 +4,5 @@ set -x
 echo Testing $(git log -1 --oneline)
 cargo check
 cargo doc
+cargo doc --document-private-items
 cd fuzz && cargo check --features=stdin_fuzz
index 0cde1aa3e6e9af4374261be045c76d74cc8e9a7d..16a8829468ec7a0323461369727142eb4bdb5a22 100644 (file)
@@ -96,6 +96,7 @@ enum InboundHTLCState {
        /// is used to derive commitment keys, which are used to construct the
        /// signatures in a commitment_signed message.
        /// Implies AwaitingRemoteRevoke.
+       ///
        /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
        AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
        /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).