[Roxygen-devel] Roxygen2 3.0.0

[Hadley Wickham]

Hi all,

This is just a quick note to let you know that I'm moving towards a
new release of roxygen2, bringing in the most important new features
and bug fixes from roxygen3. The most important new features are:

* S4 support (generics, methods and classes), generating correct
aliases and usage statements

* Better S3 support, so that you can just do `@export`, not
`@S3method` or `@export` + `@method` depending on whether you're
documenting the function or just exporting the definition

* I've also fixed a number of bugs to do with namespaces, usages and
escaping, so generally the set of situations where you need to
manually specify usage should be much much smaller.

* I'm moving towards a system where you can turn off wrapping
(https://github.com/klutometis/roxygen/pull/142) - this will be opt-in
in the current version of roxygen, but will eventually become the
default. It's just too hard to get wrapping right automatically, and
it causes a lot of problems for new users.

You can see a complete list of changes at
https://github.com/klutometis/roxygen/blob/master/NEWS.

If you are using roxygen for S4 currently, I'd really appreciate it if
you'd try it out - you should now be able to remove any custom @alias
and @usage tags.  You can try out the dev version with:

install.packages("devtools")
devtools::install_github("devtools")
devtools::install_github("roxygen", "klutometis")

You'll also need a development environment since roxygen2 now includes
a little C++ code for better escaping (and will probably include more
over time as identify performance benchmarks and move them to C++).

If you discover any bugs, please file at
https://github.com/klutometis/roxygen/issues. I'll also consider small
new features, but while roxygen2 is now in much better shape than it
was a couple of weeks ago, it's still not easy to add new features.

Hadley

-- 
Chief Scientist, RStudio
http://had.co.nz/