prettycode::default_style
without using it to suppress a NOTE, “All declared Imports should be used.”Just internal changes and tests to be ready on CRAN.
felp
is now a short of “functional help” to help things in addition to functions. It was formerly “function help”
felp()
and ?
returns structure of a value specified to the first argument if possible. If function is specified, the source of function is returned instead of the structure.felp()
utils::help
in terms of argumentshelp(package = )
?.
supports arguments other than functions.?p
is added to display document of a package.pkgdown
siteTagged, but not released.
function?.
form to print function and its help simultaneously.
.
of function?.
can be any like function?hoge
. This behavior is changed because of conflicts with type?topic
form of utils::`?`
.prettycode:::print.function()
?
?.function
provides print.function()
and help()
simultaneously.?.default
is equivalent to utils::?
print.function
as it may conflict with auto-completions of RStudio.R CMD check results gives a warning, but I have no idea to solve it.
❯ checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object '?'
‘e1’ ‘e2’
Bad \usage lines found in documentation object '?':
<unescaped bksl>method{?}{function}(e1, e2)
<unescaped bksl>method{?}{default}(e1, e2)
Functions with \usage entries need to have the appropriate \alias
entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.
A first version
felp()
and print.function()
shows help and source of a function simultaneously.