Use latest roxygen2 tags for R6 documentation
まだ誰も着手していません。
評価
- 難易度
- 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 ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
rstudio/httpuv のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 46/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 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 日以内に返信