File tree Expand file tree Collapse file tree 4 files changed +7
-7
lines changed
Expand file tree Collapse file tree 4 files changed +7
-7
lines changed Original file line number Diff line number Diff line change 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 }}
Original file line number Diff line number Diff 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.
5252pub 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.
Original file line number Diff line number Diff line change @@ -105,7 +105,7 @@ where
105105 } )
106106}
107107
108- /// Read a previously persisted [`Scorer `] from the store.
108+ /// Read a previously persisted [`ProbabilisticScorer `] from the store.
109109pub ( crate ) fn read_scorer < K : KVStore + Sync + Send , G : Deref < Target = NetworkGraph < L > > , L : Deref > (
110110 kv_store : Arc < K > , network_graph : G , logger : L ,
111111) -> Result < ProbabilisticScorer < G , L > , std:: io:: Error >
Original file line number Diff line number Diff line change 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) ]
You can’t perform that action at this time.
0 commit comments