Use latest roxygen2 tags for R6 documentation

Abierto
  • ¿Algo no está bien?
#310 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
r
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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()`
Lenguaje dominante
C
Estrellas
252
Forks
87
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de rstudio/httpuv

Todos los issues de rstudio/httpuv

Issues similares

Más issues de C

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.