Pudu programming language
Menu
API reference

Std.Args.usage

1 declaration

fn

usage: &Std.Args.Spec -> Str

This is a callable function.

What it does

The usage text a program prints when asked, or when refusing.

Built from the same spec the parsing reads, so a program cannot document an

option it does not accept or accept one it does not document.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.

Back to Std.ArgsSearch related declarations