devtools (version 1.5)

help: Drop-in replacements for help and ? functions

Description

The ? and help are drop-in replacements for functions of the same name in the utils package.

Usage

help(topic, package = NULL, ...)
"?"(e1, e2)

Arguments

topic

A name or character string specifying the help topic.

package

A name or character string specifying the package in which to search for the help topic. If NULL, seach all packages.

e1

First argument to pass along to utils::`?`.

e2

Second argument to pass along to utils::`?`.

...

Additional arguments to pass to help.

Details

The ? function is a replacement for ? from the utils package. It will search for help in devtools-loaded packages first, then in regular packages.

The help function is a replacement for help from the utils package. If package is not specified, it will search for help in devtools-loaded packages first, then in regular packages. If package is specified, then it will search for help in devtools-loaded packages or regular packages, as appropriate.

Examples

# This would load devtools and look at the help for load_all, if currently
# in the devtools source directory.
load_all()
?load_all
help("load_all")

# To see the help pages for utils::help and utils::`?`:
help("help", "utils")
help("?", "utils")