Improve docs

Author: dieghernan

NEWS.md

@@ -71,7 +71,7 @@
 
 - `cff_write()` gains a new `encoding` argument to make it work with different
   encodings. See `iconv()`.
-- Fixed **NOTEs** caused by empty lines in docs.
+- Fixed **NOTEs** caused by empty lines in documentation.
 
 # cffr 1.0.0
 

R/as_bibentry.R

@@ -195,7 +195,7 @@ as_bibentry.list <- function(x, ...) {
     return(bibentry())
   }
 
-  # Unlist to undo the do.call effect.
+  # Unlist to undo the `do.call()` effect.
   bib <- bib[[1]]
 
   bib
@@ -298,22 +298,22 @@ as_bibentry.cff_ref <- function(x, ...) {
   ### Journal ----
   tobibentry$journal <- x$journal
 
-  ### note ----
+  ### Note ----
   tobibentry$note <- get_bib_note(x)
 
   ### Number ----
   tobibentry$number <- clean_str(x[["issue"]])
 
-  ### pages ----
+  ### Pages ----
   tobibentry$pages <- clean_str(paste(
     unique(c(x$start, x$end)),
     collapse = "--"
   ))
 
-  ### publisher ----
+  ### Publisher ----
   tobibentry$publisher <- clean_str(x$publisher$name)
 
-  ### title ----
+  ### Title ----
   tobibentry$title <- x$title
 
   ### Volume ----
@@ -353,7 +353,7 @@ as_bibentry.cff_ref <- function(x, ...) {
   # Month ----
   tobibentry$month <- get_bib_month(x)
 
-  # year ----
+  # Year ----
   tobibentry$year <- get_bib_year(x)
 
   # Handle anonymous authors ----

R/as_cff_reference.R

@@ -18,7 +18,7 @@ make_cff_reference <- function(bib) {
   # Get BibTeX entry ----
   cit_list <- get_bibtex_entry(bib)
 
-  ## If there is no title (case of some Misc), return null.
+  ## If there is no title (case of some Misc), return `NULL`.
   if (!("title" %in% names(cit_list))) {
     entry <- capture.output(print(bib, bibtex = FALSE))
     entry <- as.character(entry)
@@ -44,7 +44,7 @@ make_cff_reference <- function(bib) {
 
   # Coerce persons ----
   # Special case: authors.
-  # Some keys do not strictly require authors, so create one for cff.
+  # Some keys do not strictly require authors, so create one for CFF.
   # https://github.com/citation-file-format/citation-file-format/blob/main/
   # (cont) schema-guide.md#how-to-deal-with-unknown-individual-authors
 

R/cff_gha_update.R

@@ -15,7 +15,7 @@
 #' @inherit cff_git_hook return
 #'
 #' @details
-#' Triggers on your action can be modified. See
+#' Workflow triggers can be modified. See
 #' ```{r, echo=FALSE, results='asis'}
 #'
 #' cat(paste0(" [Events that trigger workflows]",

R/deprecated.R

@@ -289,7 +289,7 @@ cff_parse_person_bibtex <- function(person) {
 #' bib <- citation("base")
 #' bib
 #'
-#' # To cff.
+#' # To `cff`.
 #' bib_to_cff <- as_cff(bib)
 #' bib_to_cff
 #'

R/utils-bib.R

@@ -165,7 +165,7 @@ make_bibkey <- function(tobibentry) {
 
   init_aut <- tobibentry$author
 
-  # Try to get the editor if the author is null.
+  # Try to get the editor if the author is `NULL`.
   if (is.null(init_aut)) {
     init_aut <- tobibentry$editor
   }

R/utils-cff_read.R

@@ -195,7 +195,7 @@ get_desc_urls <- function(pkg) {
   url <- pkg$get_urls()
   allurls <- desc_all_urls(pkg, url)
 
-  # If there are no URLs, return as null.
+  # If there are no URLs, return as `NULL`.
   if (length(allurls) == 0) {
     return(list(url = NULL))
   }

R/utils.R

@@ -31,7 +31,7 @@ clean_str <- function(str) {
   clean
 }
 
-#' Drop nulls from a list
+#' Drop `NULL` values from a list
 #' @param x A list to be cleaned.
 #' @source https://github.com/cboettig/codemeta/blob/master/R/utils.R
 #' @noRd

README.md

@@ -177,7 +177,6 @@ test <- cff_create("knitr")
       url: https://yihui.org/knitr/
     repository: https://CRAN.R-project.org/package=knitr
     repository-code: https://github.com/yihui/knitr
-    commit: '1.51'
     url: https://yihui.org/knitr/
     date-released: '2025-12-20'
     contact:
@@ -345,6 +344,23 @@ test <- cff_create("knitr")
         orcid: https://orcid.org/0000-0002-7111-0077
       year: '2026'
       doi: 10.32614/CRAN.package.bslib
+    - type: software
+      title: DBI
+      abstract: 'DBI: R Database Interface'
+      notes: Suggests
+      url: https://dbi.r-dbi.org
+      repository: https://CRAN.R-project.org/package=DBI
+      authors:
+      - name: R Special Interest Group on Databases (R-SIG-DB)
+      - family-names: Wickham
+        given-names: Hadley
+      - family-names: Müller
+        given-names: Kirill
+        email: kirill@cynkra.com
+        orcid: https://orcid.org/0000-0002-1416-3412
+      year: '2026'
+      doi: 10.32614/CRAN.package.DBI
+      version: '>= 0.4-1'
     - type: software
       title: digest
       abstract: 'digest: Create Compact Hash Digests of R Objects'
@@ -358,6 +374,21 @@ test <- cff_create("knitr")
         orcid: https://orcid.org/0000-0001-6419-907X
       year: '2026'
       doi: 10.32614/CRAN.package.digest
+    - type: software
+      title: gifski
+      abstract: 'gifski: Highest Quality GIF Encoder'
+      notes: Suggests
+      url: https://r-rust.r-universe.dev/gifski
+      repository: https://CRAN.R-project.org/package=gifski
+      authors:
+      - family-names: Ooms
+        given-names: Jeroen
+        email: jeroenooms@gmail.com
+        orcid: https://orcid.org/0000-0002-4035-0289
+      - name: Kornel Lesiński
+      - name: Authors of the dependency Rust crates
+      year: '2026'
+      doi: 10.32614/CRAN.package.gifski
     - type: software
       title: htmlwidgets
       abstract: 'htmlwidgets: HTML Widgets for R'
@@ -383,6 +414,19 @@ test <- cff_create("knitr")
       year: '2026'
       doi: 10.32614/CRAN.package.htmlwidgets
       version: '>= 0.7'
+    - type: software
+      title: jpeg
+      abstract: 'jpeg: Read and write JPEG images'
+      notes: Suggests
+      url: https://www.rforge.net/jpeg/
+      repository: https://CRAN.R-project.org/package=jpeg
+      authors:
+      - family-names: Urbanek
+        given-names: Simon
+        email: Simon.Urbanek@r-project.org
+        orcid: https://orcid.org/0000-0003-2297-1732
+      year: '2026'
+      doi: 10.32614/CRAN.package.jpeg
     - type: software
       title: magick
       abstract: 'magick: Advanced Graphics and Image-Processing in R'
@@ -396,6 +440,37 @@ test <- cff_create("knitr")
         orcid: https://orcid.org/0000-0002-4035-0289
       year: '2026'
       doi: 10.32614/CRAN.package.magick
+    - type: software
+      title: litedown
+      abstract: 'litedown: A Lightweight Version of R Markdown'
+      notes: Suggests
+      url: https://github.com/yihui/litedown
+      repository: https://CRAN.R-project.org/package=litedown
+      authors:
+      - family-names: Xie
+        given-names: Yihui
+        email: xie@yihui.name
+        orcid: https://orcid.org/0000-0003-0645-5666
+      year: '2026'
+      doi: 10.32614/CRAN.package.litedown
+    - type: software
+      title: markdown
+      abstract: 'markdown: Render Markdown with ''commonmark'''
+      notes: Suggests
+      url: https://github.com/rstudio/markdown
+      repository: https://CRAN.R-project.org/package=markdown
+      authors:
+      - family-names: Xie
+        given-names: Yihui
+        email: xie@yihui.name
+        orcid: https://orcid.org/0000-0003-0645-5666
+      - family-names: Allaire
+        given-names: JJ
+      - family-names: Horner
+        given-names: Jeffrey
+      year: '2026'
+      doi: 10.32614/CRAN.package.markdown
+      version: '>= 1.3'
     - type: software
       title: otel
       abstract: 'otel: OpenTelemetry R API'
@@ -408,6 +483,19 @@ test <- cff_create("knitr")
         email: csardi.gabor@gmail.com
       year: '2026'
       doi: 10.32614/CRAN.package.otel
+    - type: software
+      title: png
+      abstract: 'png: Read and write PNG images'
+      notes: Suggests
+      url: https://www.rforge.net/png/
+      repository: https://CRAN.R-project.org/package=png
+      authors:
+      - family-names: Urbanek
+        given-names: Simon
+        email: Simon.Urbanek@r-project.org
+        orcid: https://orcid.org/0000-0003-2297-1732
+      year: '2026'
+      doi: 10.32614/CRAN.package.png
     - type: software
       title: ragg
       abstract: 'ragg: Graphic Devices Based on AGG'
@@ -509,6 +597,18 @@ test <- cff_create("knitr")
         orcid: https://orcid.org/0000-0002-4958-2844
       year: '2026'
       doi: 10.32614/CRAN.package.sass
+    - type: software
+      title: showtext
+      abstract: 'showtext: Using Fonts More Easily in R Graphs'
+      notes: Suggests
+      url: https://github.com/yixuan/showtext
+      repository: https://CRAN.R-project.org/package=showtext
+      authors:
+      - family-names: Qiu
+        given-names: Yixuan
+        email: yixuan.qiu@cos.name
+      year: '2026'
+      doi: 10.32614/CRAN.package.showtext
     - type: software
       title: styler
       abstract: 'styler: Non-Invasive Pretty Printing of R Code'

codemeta.json

@@ -234,7 +234,7 @@
   },
   "isPartOf": "https://ropensci.org",
   "keywords": ["attribution", "citation", "credit", "citation-files", "cff", "metadata", "citation-file-format", "cran", "r", "r-package", "ropensci", "rstats", "r-cran"],
-  "fileSize": "996.118KB",
+  "fileSize": "986.856KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",