Skip to content

Update documentation to address CRAN notes#148

Merged
fmichonneau merged 4 commits intoropensci:masterfrom
villegar:master
Jan 15, 2026
Merged

Update documentation to address CRAN notes#148
fmichonneau merged 4 commits intoropensci:masterfrom
villegar:master

Conversation

@villegar
Copy link
Contributor

CRAN notes

Version: 3.1.0
Check: Rd files
Result: NOTE 
  checkRd: (-1) get_study_meta.Rd:54-55: Lost braces in \itemize; meant \describe ?
  checkRd: (-1) get_study_meta.Rd:57-60: Lost braces in \itemize; meant \describe ?
  checkRd: (-1) get_study_meta.Rd:62-68: Lost braces in \itemize; meant \describe ?
  checkRd: (-1) get_study_meta.Rd:66: Lost braces; missing escapes or markup?
      66 |   \item {get_study_year} { The year of publication of the study. }
         |         ^
  checkRd: (-1) get_study_meta.Rd:66: Lost braces; missing escapes or markup?
      66 |   \item {get_study_year} { The year of publication of the study. }
         |                          ^
  checkRd: (-1) rotl.Rd:27-31: Lost braces in \itemize; meant \describe ?
  checkRd: (-1) rotl.Rd:33-36: Lost braces in \itemize; meant \describe ?
  checkRd: (-1) taxonomy_about.Rd:17-18: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_about.Rd:20: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_about.Rd:22: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_about.Rd:24-25: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_about.Rd:27: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_mrca.Rd:43-45: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_mrca.Rd:47-48: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_mrca.Rd:50-51: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_mrca.Rd:53-54: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_subtree.Rd:35-38: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_subtree.Rd:40-42: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_subtree.Rd:44-45: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) taxonomy_subtree.Rd:47-49: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:38: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:40-41: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:43-44: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:46-47: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:49-50: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:52: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:54: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:56: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:58: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:60: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:62: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:64-65: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:67: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:69-71: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:75-80: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:82-85: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:88-89: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:91: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:93-94: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_about.Rd:97: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:42: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:45: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:47: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:49-51: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:54: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:56: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:58-59: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:61: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:63-65: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:73-75: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:77-79: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:81-84: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:86-88: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:91-93: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:96: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:98: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:100-101: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:103: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:105-107: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:110-112: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:115-116: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:118: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_mrca.Rd:120-121: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:55: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:57: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:59-61: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:63-64: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:66-67: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:70: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:72: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:74-75: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:77: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:79-81: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:88-90: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:92-96: Lost braces in \itemize; \value handles \item{}{} directly
  checkRd: (-1) tol_node_info.Rd:98-100: Lost braces in \itemize; \value handles \item{}{} directly

Context

This task was proposed by R Core developer Kurt Hornik as part of an initiative to improve CRAN package documentation. Packages with public repositories (GitHub, GitLab, Bitbucket) and a higher number of reverse dependencies were prioritised. This PR has been completed as part of an R Dev Day at the University of Warwick on 12 Sept 2025 (see r-devel/r-dev-day#110).

@fmichonneau fmichonneau merged commit a034161 into ropensci:master Jan 15, 2026
1 check failed
@fmichonneau
Copy link
Member

Thank you for this!

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