get_param_docs: Look up a function's parameter documentation

View source: R/schema_generator.R

get_param_docsR Documentation

Look up a function's parameter documentation

Description

Part of the companion-package extension API (used by aisdk.datatools).

Usage

get_param_docs(func_name, package = NULL)

Arguments

func_name

Name of the function whose parameter docs to read.

package

Optional package name containing the function.

Value

A named character vector of parameter descriptions.


aisdk documentation built on May 29, 2026, 9:07 a.m.