Use latest roxygen2 tags for R6 documentation
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- r
调研方向
Run devtools::document() and inspect the R6 documentation in R/httpuv.R and R/server.R, focusing on the warnings listed in the issue. Update the documentation to use the current R6 tags and rerun devtools::document(); done means the listed undocumented methods, fields, and arguments no longer produce warnings.
由索引模型根据 Issue 内容生成。
描述
Calling devtools::document() produces many warnings.
Currently:
Warning: [./httpuv/R/httpuv.R:389] undocumented R6 methods: `initialize`, `onMessage`, `onClose`, `send`, `close`
Warning: [./httpuv/R/httpuv.R:389] undocumented R6 fields: `handle`, `messageCallbacks`, `closeCallbacks`, `request`
Warning: [./httpuv/R/httpuv.R:392] argument `handle` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/httpuv.R:392] argument `req` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/httpuv.R:396] argument `func` undocumented for R6 method `onMessage()`
Warning: [./httpuv/R/httpuv.R:399] argument `func` undocumented for R6 method `onClose()`
Warning: [./httpuv/R/httpuv.R:402] argument `message` undocumented for R6 method `send()`
Warning: [./httpuv/R/httpuv.R:413] argument `code` undocumented for R6 method `close()`
Warning: [./httpuv/R/httpuv.R:413] argument `reason` undocumented for R6 method `close()`
Warning: [./httpuv/R/server.R:49] undocumented R6 methods: `stop`, `isRunning`, `getStaticPaths`, `setStaticPath`, `removeStaticPath`, ...
Warning: [./httpuv/R/server.R:71] argument `...` undocumented for R6 method `setStaticPath()`
Warning: [./httpuv/R/server.R:71] argument `.list` undocumented for R6 method `setStaticPath()`
Warning: [./httpuv/R/server.R:78] argument `path` undocumented for R6 method `removeStaticPath()`
Warning: [./httpuv/R/server.R:89] argument `...` undocumented for R6 method `setStaticPathOption()`
Warning: [./httpuv/R/server.R:89] argument `.list` undocumented for R6 method `setStaticPathOption()`
Warning: [./httpuv/R/server.R:160] undocumented R6 methods: `initialize`, `getHost`, `getPort`
Warning: [./httpuv/R/server.R:164] argument `host` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:164] argument `port` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:164] argument `app` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:164] argument `quiet` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:251] undocumented R6 methods: `initialize`, `getName`, `getMask`
Warning: [./httpuv/R/server.R:255] argument `name` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:255] argument `mask` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:255] argument `app` undocumented for R6 method `initialize()`
Warning: [./httpuv/R/server.R:255] argument `quiet` undocumented for R6 method `initialize()`
- 主要语言
- C
- 星标
- 252
- 派生
- 87
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
rstudio/httpuv 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 64/100
-
难度 4/5 3-5 天 新手友好度 46/100
-
难度 5/5 一周以上 新手友好度 30/100
-
难度 4/5 3-5 天 新手友好度 45/100
-
难度 4/5 3-5 天 新手友好度 35/100
相似的 Issue
-
Status: Opened
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
FriendsofECCE/ECCE#1018 ·
-
难度 2/5 1-3 小时 新手友好度 62/100
immortalwrt/immortalwrt#2522 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
severity: low
难度 2/5 1-3 小时 新手友好度 64/100
luainkernel/lunatik#2530 ·
维护者通常 1 天内回复