Merge pull request #4877 from IntersectMBO/amesgen/TrustedStateWithEx…

…ternalPeers-fix-docs Fix haddocks for `TrustedStateWithExternalPeers`
IntersectMBO · May 8, 2024 · 821feaa · 821feaa
2 parents 431bb59 + 00c8806
commit 821feaa
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/ouroboros-network-api/src/Ouroboros/Network/PeerSelection/LocalRootPeers.hs b/ouroboros-network-api/src/Ouroboros/Network/PeerSelection/LocalRootPeers.hs
@@ -11,8 +11,9 @@ data OutboundConnectionsState =
     -- * /in the Praos mode/: connected only to trusted local
     --   peers and at least one bootstrap peer or public root;
     -- * /in the Genesis mode/: meeting target of active big ledger peers;
-    -- * or it is in `Unrestricted` mode
-    --   (see `Ouroboros.Network.PeerSelection.Governor.AssociationMode`).
+    -- * or it is in `LocalRootsOnly` mode and indeed only connected to
+    --   trusted local root peers (see
+    --   `Ouroboros.Network.PeerSelection.Governor.AssociationMode`).
 
   | UntrustedState
     -- ^ catch all other cases