Skip to content

Commit 09c5950

Browse files
committed
Check documentation building in CI
Now that we split out UniFFI to its own feature, we can make use of the `missing_docs` lint again and enforce it in CI for release docs as well as private items.
1 parent 644f2ed commit 09c5950

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

.github/workflows/build.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ jobs:
2424
run: cargo build --verbose --color always
2525
- name: Build with UniFFI support on Rust ${{ matrix.toolchain }}
2626
run: cargo build --features uniffi --verbose --color always
27+
- name: Build documentation on Rust ${{ matrix.toolchain }}
28+
run: |
29+
cargo doc --release --verbose --color always
30+
cargo doc --document-private-items --verbose --color always
2731
- name: Check release build on Rust ${{ matrix.toolchain }}
2832
run: cargo check --release --verbose --color always
2933
- name: Check release build with UniFFI support on Rust ${{ matrix.toolchain }}

src/io/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ pub(crate) const LATEST_NODE_ANN_BCAST_TIMESTAMP_KEY: &str = "latest_node_ann_bc
5050
/// Keys and namespaces are required to be valid ASCII strings and the empty namespace (`""`) is
5151
/// assumed to be valid namespace.
5252
pub trait KVStore: KVStorePersister {
53+
/// A reader as returned by [`Self::read`].
5354
type Reader: Read;
5455
/// Returns a [`Read`] for the given `namespace` and `key` from which [`Readable`]s may be
5556
/// read.

src/io/utils.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ where
106106
})
107107
}
108108

109-
/// Read a previously persisted [`Scorer`] from the store.
109+
/// Read a previously persisted [`ProbabilisticScorer`] from the store.
110110
pub(crate) fn read_scorer<
111111
K: KVStore + Send + Sync,
112112
G: Deref<Target = NetworkGraph<L>>,

src/lib.rs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,7 @@
6363
//! [`connect_open_channel`]: Node::connect_open_channel
6464
//! [`send_payment`]: Node::send_payment
6565
//!
66-
67-
// We currently disable the missing_docs lint due to incompatibility with the generated Uniffi
68-
// scaffolding.
69-
// TODO: Re-enable after https://github.com/mozilla/uniffi-rs/issues/1502 has been
70-
// addressed.
71-
//#![deny(missing_docs)]
66+
#![cfg_attr(not(feature = "uniffi"), deny(missing_docs))]
7267
#![deny(rustdoc::broken_intra_doc_links)]
7368
#![deny(rustdoc::private_intra_doc_links)]
7469
#![allow(bare_trait_objects)]

0 commit comments

Comments
 (0)