Skip to content

Commit bacc85e

Browse files
authored
update roxygen2 wording (#793)
* update roxygen2 wording * align English and Spanish
1 parent c6d35f0 commit bacc85e

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

booknews.Rmd

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## dev (0.9.0)
44

5+
- 2024-01-09, update roxygen2 wording (`@vincentvanhees`, #792).
6+
57
- 2023-12-15, update roxygen2 advice, mainly linking to roxygen2 website (#750).
68

79
- 2023-09-15, add suggestions for API packages (#496).

pkg_building.Rmd

+3-3
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,11 @@ The general vignette should present a series of examples progressing in complexi
221221

222222
### roxygen2 use {#roxygen-2-use}
223223

224-
- We request all submissions to use [roxygen2](https://roxygen2.r-lib.org/) for documentation. roxygen2 is an R package that automatically compiles `.Rd` files to your `man` folder in your package from simple tags written above each function.
224+
- We request all submissions to use [roxygen2](https://roxygen2.r-lib.org/) for documentation. roxygen2 is an R package that compiles `.Rd` files to your `man` folder in your package from tags written above each function. roxygen2 has [support for Markdown syntax](https://roxygen2.r-lib.org/articles/rd-formatting.html). One key advantage of using roxygen2 is that your `NAMESPACE` will always be automatically generated and up to date.
225225

226-
- More information on using roxygen2 documentation is available in the [R packages book](https://r-pkgs.org/man.html) and in [roxygen2 website itself](https://roxygen2.r-lib.org/). One key advantage of using roxygen2 is that your `NAMESPACE` will always be automatically generated and up to date.
226+
- More information on using roxygen2 documentation is available in the [R packages book](https://r-pkgs.org/man.html) and in [roxygen2 website itself](https://roxygen2.r-lib.org/).
227227

228-
- If you were writing Rd by hand, the [Rd2roxygen](https://cran.r-project.org/web/packages/Rd2roxygen/index.html) package contains functions to convert Rd to roxygen documentation.
228+
- If you were writing Rd directly without roxygen2, the [Rd2roxygen](https://cran.r-project.org/web/packages/Rd2roxygen/index.html) package contains functions to convert Rd to roxygen documentation.
229229

230230
- All functions should document the type of object returned under the `@return` heading.
231231

pkg_building.es.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -244,11 +244,11 @@ La viñeta general debe presentar una serie de ejemplos que progresen en complej
244244
### Uso de roxygen2 {#roxygen-2-use}
245245

246246
- Pedimos que todos los paquetes que se presenten para revisión utilicen [roxygen2](https://roxygen2.r-lib.org/) para generar la documentación.
247-
roxygen2 es un paquete de R que compila automáticamente archivos `.Rd` en la carpeta `man` del paquete utilizando etiquetas incluidas antes de cada función. Una ventaja clave de utilizar roxygen2 es que tu archivo `NAMESPACE` siempre se generará automáticamente y estará actualizado.
247+
roxygen2 es un paquete de R que compila automáticamente archivos `.Rd` en la carpeta `man` del paquete utilizando etiquetas incluidas antes de cada función. roxygen2 tiene [soporte para la sintaxis Markdown](https://roxygen2.r-lib.org/articles/rd-formatting.html). Una ventaja clave de utilizar roxygen2 es que tu archivo `NAMESPACE` siempre se generará automáticamente y estará actualizado.
248248

249249
- Más información sobre el uso de roxygen2 para generar documentación está disponible [en el libro *R Packages*](https://r-pkgs.org/man.html) y en [el sitio web de roxygen2](https://roxygen2.r-lib.org/).
250250

251-
- Si escribiste los archivos .Rd a mano, el paquete [Rd2roxygen](https://cran.r-project.org/web/packages/Rd2roxygen/index.html) contiene funciones para convertir la documentación de Rd a documentación de roxygen2.
251+
- Si escribiste los archivos .Rd directamente sin roxygen2, el paquete [Rd2roxygen](https://cran.r-project.org/web/packages/Rd2roxygen/index.html) contiene funciones para convertir la documentación de Rd a documentación de roxygen2.
252252

253253
- Todas las funciones deben documentar el tipo de objeto devuelto bajo el encabezado `@return`.
254254

0 commit comments

Comments
 (0)