IntersectMBO / IntersectMBO/ouroboros-network

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

Open
#4,678 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
296
Forks
104
Avg merge
2d 10h
Merged PRs (30d)
4

Description

`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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.