Giters

IntersectMBO / ouroboros-network

Specifications of network protocols and implementations of components running these protocols which support a family of Ouroboros Consesus protocols; the diffusion layer of the Cardano Node.

Home Page:https://ouroboros-network.cardano.intersectmbo.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document `O.N.BlockFetch.ClientRegistry.setFetchClientContext`

samcowger opened this issue · comments

commented

setFetchClientContext is currently rendered like so:
https://github.com/input-output-hk/ouroboros-network/blob/cdd54f98c6743f5fd7bfe0d5a9d0b0f8a4a10b73/ouroboros-network/src/Ouroboros/Network/BlockFetch/ClientRegistry.hs#L291-L301
The rationale for the error case is not immediately obvious. The function's docstring should document the presence and rationale of the contract suggested by this error.