libhelp

package

v1.17.2 Latest Latest Go to latest Published: Feb 12, 2026 License: BSD-3-Clause Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luthersystems/elps

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func LoadPackage(env *lisp.LEnv) *lisp.LVal
func RenderPackageList(w io.Writer, env *lisp.LEnv) error
func RenderPkgExported(w io.Writer, env *lisp.LEnv, query string) error
func RenderVar(w io.Writer, env *lisp.LEnv, sym string) error
type MissingDoc
- func CheckMissing(env *lisp.LEnv) []MissingDoc

Constants ¶

View Source

const DefaultPackageName = "help"

DefaultPackageName is the package name used by LoadPackage.

Variables ¶

This section is empty.

Functions ¶

func RenderPackageList ¶ added in v1.16.12

func RenderPackageList(w io.Writer, env *lisp.LEnv) error

RenderPackageList writes a summary of all loaded packages to w. Each package is listed with its name, export count, and first line of its doc string (if any). Packages are sorted alphabetically.

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.

Types ¶

type MissingDoc ¶ added in v1.17.0

type MissingDoc struct {
	// Kind is the type of the symbol: "builtin", "special-op", "macro",
	// "package", or a function type string (e.g. "function").
	Kind string

	// Name is the qualified name of the symbol (e.g. "math:sin").
	Name string
}

MissingDoc describes a symbol with no documentation.

func CheckMissing ¶ added in v1.17.0

func CheckMissing(env *lisp.LEnv) []MissingDoc

CheckMissing reports symbols missing documentation in the given environment. It checks core builtins/ops/macros (from DefaultBuiltins etc.), package-level docs, and exported symbol docs for all packages in env.Runtime.Registry.