Extract docstring-documentation from a function

Extract docstring-documentation from a function

Usage

extract_function_docs(func)

Arguments

func

A function object which has internal, roxygen-like documentation, with the 'llm_tool::' tags: 'name', 'description', 'param', 'return', and 'example' (e.g., llm_tool::name my_function_name).

Note that for 'example' it must be a one-line example of how the function is used in R, this will be converted to how LLM should call the function in text (slightly different syntax).

Value

A list with the following elements:

• name: The name of the function

• description: A description of the function

• parameters: A named list of parameters with descriptions

• return_value: A description of the return value

• example: An example of how the LLM should call the function