Use latest roxygen2 tags for R6 documentation

Đang mở
  • Có gì không ổn?
#310 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
r
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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()`
Ngôn ngữ chính
C
Star
252
Fork
87
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của rstudio/httpuv

Tất cả issue của rstudio/httpuv

Issue tương tự

Thêm issue về C

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.