Documentation Request about Ping Pong
- 主要语言
- Go
- 星标
- 5.5k
- 派生
- 372
- PR 合并指标
- 30 天内没有已合并 PR
描述
Hello nhooyr,
In gorilla/websocket, end-users must explicitly handle pings and pongs. From what I am reading on the issues forum, nhooyr/websocket handles this automatically. This is also implied by reading the source code from the [chat example](https://github.com/nhooyr/websocket/tree/master/examples/chat), which doesn't seem to have any ping pong code.
Can this please be documented front and center in the README? Right now, the README simply states that there is a "Ping pong API", but this doesn't communicate to the end user whether or not they should be writing pong pong code in their application or not.
Maybe the text of "Ping pong API" should be changed to "Automatic handling of pings and pongs, with an API exposing functionality for advanced users", or something along those lines. I would write a PR, but it's a one line change and you can probably word it the way you want yourself.
The reason that this seems important is that I expect typical writers of Go software will have used gorilla/websocket in the past, and are used to handling ping/pongs, so this will be a repeated point of confusion as more and more users use this library.
In closing, thanks for the library.
贡献指南
这个仓库没有索引到贡献指南
调研方向
从 README 中现有的“Ping pong API”文本开始,并查看 issue 中引用的 examples/chat 目录以了解上下文。在 README 中明确说明 ping 和 pong 是否会自动处理,以及该 API 面向高级用户;当 README 消除所述歧义时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- go
- 领域
- documentation, networking
- Issue 类型
- 文档
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 35/100