Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propuesta de mejoras en la documentación #1

Merged
merged 3 commits into from
Sep 7, 2023

Conversation

dieghernan
Copy link
Member

Hola @hmeleiro

Gracias por este paquete, tiene una pinta genial!

Le he estado echando un vistazo y te propongo una serie de mejores documentales, siéntete libre de aceptarlas o rechazarlas:

  • Lo primero de todo (importante), he configurado el paquete para que pueda usar markdown en la documentación (he visto que lo estabas usando) y que roxygen2 lo reconozca como tal. Eso se consigue añadiendo en DESCRIPTION la línea Roxygen: list(markdown = TRUE).
  • He revisado y añadido urls de GitHub en el DESCRIPTION
  • He actualizado varias urls que estaban desactualizadas
  • He configurado el paquete para que cree una página de ayuda general sobre el mismo, echa un vistazo a https://usethis.r-lib.org/reference/use_package_doc.html donde lo explica mejor.
  • He corregido erratas mínimas en el vignette.
  • He configurado tu pkgdown para que use nuestra plantilla. Puedes ver como quedaría el sitio web en este link.

Saludos y gracias

@hmeleiro
Copy link
Member

hmeleiro commented Sep 7, 2023

Me parece todo genial. Muchas gracias por revisarlo. Procedo a hacer el merge.

@hmeleiro hmeleiro closed this Sep 7, 2023
@hmeleiro hmeleiro reopened this Sep 7, 2023
@hmeleiro hmeleiro merged commit 32cdef9 into rOpenSpain:main Sep 7, 2023
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants