tests/testthat/_snaps/rd.md

documenting unknown function requires name

[<text>:6] Block must have a @name
i Either document an existing object or manually specify with @name

can't set description and re-export

[<text>:4] Block must not include a description when re-exporting a function

documenting NA gives useful error message (#194)

[<text>:3] Block must have a @name
i Either document an existing object or manually specify with @name

can generate nonASCII document

Code
  roxygenise(roclets = "rd")
Message
  i Loading testNonASCII
  Writing 'printChineseMsg.Rd'
Code
  # Second run should be idempotent
  roxygenise(roclets = "rd")
Message
  i Loading testNonASCII

unicode escapes are ok

Code
  roxygenise(roclets = "rd")
Message
  i Loading testUtf8Escape
  Writing 'a.Rd'
Code
  # Second run should be idempotent
  roxygenise(roclets = "rd")
Message
  i Loading testUtf8Escape

automatically deletes unused files

Code
  roxygenise()
Message
  i Loading empty
  Deleting 'test.Rd'


Try the roxygen2 package in your browser

Any scripts or data that you put into this service are public.

roxygen2 documentation built on Dec. 9, 2022, 1:09 a.m.