Document `O.N.BlockFetch.ClientRegistry.setFetchClientContext`
samcowger opened this issue · comments
Sam Cowger 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.