]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Unhide struct docs in scoring module
authorJeffrey Czyz <jkczyz@gmail.com>
Sat, 12 Feb 2022 04:14:06 +0000 (22:14 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Fri, 18 Feb 2022 21:34:07 +0000 (15:34 -0600)
The docs were hidden since a type alias should be used. However, the
alias docs don't contain much useful information and don't link to the
corresponding struct.

lightning/src/routing/scoring.rs

index b02b61fa9f6c0381fe9fd7ffcad4eedd23656be5..dfda3d2f867d189c7f36de9b45072c01bed98816 100644 (file)
@@ -246,7 +246,6 @@ type ConfiguredTime = time::Eternity;
 /// [`Score`] implementation.
 ///
 /// (C-not exported) generally all users should use the [`Scorer`] type alias.
-#[doc(hidden)]
 pub struct ScorerUsingTime<T: Time> {
        params: ScoringParameters,
        // TODO: Remove entries of closed channels.
@@ -493,7 +492,6 @@ pub type ProbabilisticScorer<G> = ProbabilisticScorerUsingTime::<G, ConfiguredTi
 /// Probabilistic [`Score`] implementation.
 ///
 /// (C-not exported) generally all users should use the [`ProbabilisticScorer`] type alias.
-#[doc(hidden)]
 pub struct ProbabilisticScorerUsingTime<G: Deref<Target = NetworkGraph>, T: Time> {
        params: ProbabilisticScoringParameters,
        network_graph: G,