doc: Display in-body function documentation (a "docstring")

In alekrutkowski/clojR: Clojure-inspired functions (macros) in R

Description

See https://clojuredocs.org/clojure.repl/doc. The "docstring" is extracted from the comments starting with a double hash character (##).

Usage

doc(f)

Arguments

f	A function.

Examples

fff <- function(x = 1) {
    ## This is my function:
    ## argument x, default 1.
    ## returns x + 10.
    x + 10
}
doc(fff)
# displays in the console:

# This is my function:
# argument x, default 1.
# returns x + 10

alekrutkowski/clojR documentation built on May 11, 2019, 11:24 p.m.