help

Builtin index · REPL & diagnostics

help("curve_fit")

Input: "curve_fit" · Output: no output

What it is

Takes one argument, a builtin name (a string, e.g. "curve_fit"). Prints what is known about that name directly to the console and returns none — that it exists, near matches when it does not (e.g. help("not_a_real_fn") suggests close spellings), and where the worked examples live. Honest about its limits — the engine carries no per-builtin prose.

Overloads

One call shape — this function is not overloaded.

Code	Input	Output	Description
`help("curve_fit")`	`"curve_fit"` stringnot documented yet	no output	Takes one argument, a builtin name (a string, e.g. Prints what is known about that name directly to the console and returns `none` — that it exists, near matches when it does not (e.g. `help("not_a_real_fn")` suggests close spellings), and where the worked examples live. Honest about its limits — the engine carries no per-builtin prose.

Examples

From the documentation, and run by the build -- the output and the figure below are what the engine actually produced. Simplest first.

print(help("read_csv"))
#   read_csv is a Qu builtin.

#   related: read, re

#   worked examples live in catalog/ -- search it for `read_csv(`.

output

  read_csv(path, [headers=true], [sep=","], [decimal="."])
  Reads a CSV file into a `Table`.
  related: read, re
  full reference: website/fn/read_csv.html
  worked examples live in catalog/ -- search it for `read_csv(`.
none

from agent-guide

names = builtins()
print("total builtins: {len(names)}")
hits = apropos("filter")
print("filter-related: {hits}")
help("curve_fit")

from repl-diagnostics

How it works

help("curve_fit") -- prints what is known about a name. Honest about its limits: there is no per-builtin documentation in the engine, so this confirms a name exists, offers near matches when it does not, and points at where the worked examples actually live. That is strictly more than "unknown function" and it does not pretend to be a manual it isn't.

From the note above this builtin in the interpreter, where the reasoning was written down as it was built.