Broken "reference" from framed::WsConfig to crate::WsConfig
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 5.6k
- Forks
- 1.3k
- Avg merge
- 8h 47m
- Merged PRs (30d)
- 19
Description
The doc for framed::WsConfig states:
https://github.com/libp2p/rust-libp2p/blob/a898a0478c60369c651003ba785d2f5108981d16/transports/websocket/src/framed.rs#L52-L56
Yet, when checking the config, nothing mentions the framed vs non-framed
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the documentation for framed::WsConfig in transports/websocket/src/framed.rs with the configuration documentation in transports/websocket/src/lib.rs. Check why the reference does not explain the framed versus non-framed distinction, then update the documentation so the link and terminology are accurate. Done means the config docs clearly describe the distinction and the reference resolves to the intended material.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100