tests/testthat/_snaps/check-doc.md

In devtools: Tools to Make Developing R Packages Easier

check_doc_fields output - missing fields

Code
  check_doc_fields(pkg)
Message
  ! Missing `\value` section in 1 file:
  * man/foo.Rd
  ! Missing `\examples` section in 1 file:
  * man/bar.Rd

check_doc_fields output - all present

Code
  check_doc_fields(pkg)
Message
  v All Rd files have a `\value` section.
  v All Rd files have a `\examples` section.

check_man works

Code
  check_man(pkg)
Message
  i Updating {package} documentation
  i Loading {package}
  i Checking documentation...
Output
  Rd files without \alias:
    'foo.Rd'
  Rd files without \description:
    'foo.Rd'
  Argument items with no description in Rd file 'foo.Rd':
    'foo'
  Undocumented arguments in Rd file 'foo.Rd'
    'x'

devtools documentation built on March 14, 2026, 5:06 p.m.