Path to this page:
Subject: CVS commit: pkgsrc/devel/R-roxygen2
From: Makoto Fujiwara
Date: 2020-09-20 06:29:28
Message id: 20200920042928.427C8FB28@cvs.NetBSD.org
Log Message:
(devel/R-roxygen) Updated 6.1.1 to 7.1.1, make test fails, missing TEST_DEPENDS
# roxygen2 7.1.1
----------------
* When processing cross package markdown links (e.g. `[pkg::fun()]`),
roxygen2 now looks up the file it needs to link to, instead of linking to
the topic, to avoid "Non-file package-anchored links" `R CMD check` \
warnings.
* R6 methods and re-exported functions are always sorted in the C locale;
this ensures they're always sorted the same way in every environment (#1077).
* roxygen2 now supports inline markdown code and code chunks inside
Rd tags. In particular in `\out{}` (#1115).
# roxygen2 7.1.0
## New features
* roxygen2 now supports inline markdown code and also code chunks,
using the same notation as the knitr package. For example:
```R
#' This manual was generated at: `r Sys.time()`.
#' ...
#' `mtcars` is a data frame with `r ncol(mtcars)` columns, here
#' is a summary of them:
#'
#' ```{r}
#' summary(mtcars)
#' ```
```
See `vignette("rd-formatting")` for details.
* roxygen2 now keeps using Windows (CR LF) line endings for files that
already have CR LF line endings, and uses LF for new files (#989).
## Minor improvements and bug fixes
* Auto-generated package documentation can now handle author ORCID comments
containing full url (#1040).
* Hyperlinks to R6 methods are also added in the PDF manual (#1006).
* Empty annotations (alternate text) for figures added via markdown are now
omitted. This caused issues when generating pkgdown web sites (#1051).
* Roxygen metadata can now have a `packages` element, giving a character vector
of package names to load. This makes it easier to use extension package that
provide new tags for existing roclets (#1013). See `?load_options` for
more details.
```yaml
Roxygen: list(markdown = TRUE, packages = "roxygenlabs")
```
* `@evalNamespace()` works again (#1022).
* `@description NULL` and `@details NULL` no longer fail; instead, these tags
are ignored, except for `@description NULL` in package level documentation,
where it can be used to suppress the auto-generated Description section
(#1008).
* Multiple `@format` tags are now combined (#1015).
* The warning for `@section` titles spanning multiple lines now includes a
hint that you're missing a colon (@maelle, #994).
* Can now document objects created with `delayedAssign()` by forcing
evaluation at documentation time (#1041)
# roxygen2 7.0.2
----------------
* `\example{}` escaping has been improved (again!) so that special escapes
within strings are correctly escaped (#990).
# roxygen2 7.0.1
----------------
* `@includeRmd` has now an optional second argument, the top level section
the included file will go to. It defaults to the details section (#970).
Code chunks are now evaluated in a child of the global environment (#972).
* `@inheritParams` does a better job of munging links.
Links of the form `\link[=topic]{text}` are now automatically converted to
`\link[pkg:topic]{text}` when inherited from other packages (#979).
Internal `has_topic()` helper has a better implementation; this means that
links should no longer be munged unnecessarily (#973).
* `\example{}` escaping has been considerably simplified (#967), and is now
documented in `escape_example()`.
* In `\usage{}`, S3/S4 methods are no longer double-escaped (#976).
* Markdown tables with cells that contain multiple elements (e.g. text and code)
are now rendered correctly (#985).
* Markdown code blocks containing operators and other special syntax
(e.g. `function`, `if`, `+`) now converted to `\code{}` not `\verb{}` (#971).
# roxygen2 7.0.0
----------------
## New features
### New tags
* `@includeRmd {path.Rmd}` converts an `.Rmd`/`.md` file to `.Rd` and includes
it in the manual page. This allows sharing text between vignettes,
`README.Rmd`, and the documentation. See `vignette("rd")` for \
details (#902).
* `@order {n}` tag controls the order in which blocks are processed. You can
use it to override the usual ordering which proceeds from the top of
each file to the bottom. `@order 1` will be processed before `@order 2`,
and before any blocks that don't have an explicit order set (#863).
* `@exportS3Method` tag allows you to generate `S3method()` namespace
directives (note the different in capitalisation) (#796). Its primary use is
for "delayed" method registration, which allows you to define methods for
generics found in suggested packages (available in R 3.6 and greater).
For example,
```R
#' @exportS3Method package::generic
generic.foo <- function(x, ...) {
}
```
will generate
```
S3method(package::generic, foo)
```
(See [`vctrs::s3_register()`](https://vctrs.r-lib.org/reference/s3_register.html)
you need a version that works for earlier versions of R).
It also has a two argument form allows you generate arbitrary `S3method()`
directives:
```R
#' @exportS3Method generic class
NULL
```
```
S3method(generic, class)
```
* New `@returns` is an alias for `@return` (#952).
Files: