libhelp

Documentation

Index

• Constants
• func FunDocstring(v *lisp.LVal) string
• func LoadPackage(env *lisp.LEnv) *lisp.LVal
• func RenderPkgExported(w io.Writer, env *lisp.LEnv, query string) error
• func RenderVar(w io.Writer, env *lisp.LEnv, sym string) error

Constants

const DefaultPackageName = "help"

DeafultPackageName is the package name used by LoadPackage.

Functions

func FunDocstring

func FunDocstring(v *lisp.LVal) string

FunDocstring returns the docstring of the function reference v. If v is not a function FunDocstring returns the empty string.

func LoadPackage

func LoadPackage(env *lisp.LEnv) *lisp.LVal

LoadPackage adds the math package to env

func RenderPkgExported

func RenderPkgExported(w io.Writer, env *lisp.LEnv, query string) error

RenderPkgExported writes to w formatted documentation for exported symbols in the query package within env. The exact formatting of the rendered documentation is subject to change across elps versions.

func RenderVar

func RenderVar(w io.Writer, env *lisp.LEnv, sym string) error

RenderVar writes to w formatted documentation for the object referenced by sym in the context of env. The exact formatting of the rendered documentation is subject to change across elps versions.