forked from yihui/Rd2roxygen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNEWS
142 lines (83 loc) · 3.95 KB
/
NEWS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
CHANGES IN Rd2roxygen VERSION 1.1
NEW FEATURES
o \item{} in the \value{} section will be formatted as the
@returnItem tag, which is a new tag in roxygen2 (> 2.2.2) (#8)
(thanks, Andreas Alfons)
o R code in \dontrun{}, \dontshow{} and \donttest{} can be
reformatted by formatR now
MINOR CHANGES
o the vignette is built with knitr via the Makefile; in previous
versions, it was a fake Rnw document (essentially a weaved tex file)
o dependency on roxygen2 and formatR was changed to Imports
o default value for 'check.opts' in rab() is '--as-cran' now
CHANGES IN Rd2roxygen VERSION 1.0-7
NEW FEATURES
o @section is supported now: \section{title}{content} will be
converted to ##' @section title: content (thanks, Brian G. Peterson)
MINOR CHANGES
o the package vignette now compiles with knitr instead of Sweave
CHANGES IN Rd2roxygen VERSION 1.0-6
BUG FIXES
o \dontrun{} can be correctly reformatted now; there was a bug in
the previous version when options(replace.assign = TRUE)
CHANGES IN Rd2roxygen VERSION 1.0-5
NEW FEATURES
o usage for S3 methods like \method{generic}{class}(param = value)
can be correctly reformatted now; in previous versions rab() will
ignore such usage sections
CHANGES IN Rd2roxygen VERSION 1.0-4
NEW FEATURES
o Rd files that have \docType{data} or \docType{package} (for
datasets and package documentation) are written into xxx-package.R
directly; these names are not looked up in R scripts under the R
directory of the source package
o Rd comments (following %) will be ignored when generating roxygen
comments for arguments
CHANGES IN Rd2roxygen VERSION 1.0-3
NEW FEATURES
o a complete example of running Rd2roxygen() on a real package was
added to ?Rd2roxygen
o re-run Rd2roxygen() on a package will remove the roxygen comments
in R scripts before adding new roxygen comments parsed from Rd
files; in old versions of this package, the old roxygen comments
were not removed, hence the comments were added incrementally above
the function objects, which was certainly not desirable
MINOR CHANGES
o all these forms of quotes in assignments are allowed in
Rd2roxygen(): `foo` <-, 'foo' <-, "foo" <-, and = can be used as the
assigning operator as well
CHANGES IN Rd2roxygen VERSION 1.0-2
MAJOR CHANGES
o the usage sections in Rd files will be reformatted by default
again when calling rab() (this feature was formerly removed in
version 1.0-0)
MINOR CHANGES
o rab(..., install = TRUE) will install the *.tar.gz file rather
than the package directory; similarly, rab(..., check = TRUE) checks
the tar ball as well
CHANGES IN Rd2roxygen VERSION 1.0-1
MINOR CHANGES
o the percent symbols in the examples code will be unescaped
(i.e. \% becomes %) before the code is reformatted, then escaped
again; this can avoid errors when reformatting the code, since \% is
an illegal character in R
CHANGES IN Rd2roxygen VERSION 1.0-0
NEW FEATURES
o Rd2roxygen uses the brand-new roxygen2 rather than the old
roxygen package which is no longer maintained; users are recommended
to read the NEWS file of roxygen2 carefully. Some major changes
include: the description is in the second *paragraph* rather than
the second *line* now (i.e. there is an empty line between the title
and description); @format and @source are supported, and a series of
new tags are introduced in roxygen2 too
MAJOR CHANGES
o the escape and use.Rd2 arguments are removed in rab() since
roxygen2 can handle these cases elegantly
o roxygen.dir is the same as the package directory by default, so
rab() will write all the documentations in the original package
directory
o the usage section is no longer reformatted by formatR; roxygen2
formats it nicely
o the function rm_undocumented() is no longer needed, so it was
removed from this package; use @noRd if you do not want the
documentation of a certain object to be generated by roxygen2