description

Attaches a description string to CLI metadata.

Syntax: @ description <string>

Category#

cli

Related#

• versio

Examples#

radix/corpus/descriptio/descriptio.fab (canonical · keyword)#

Attaches a description string to CLI metadata.

# =============================================================================
# description — Attaches a description string to CLI metadata.
# =============================================================================
#
# What this teaches:
#   • CLI metadata — `@ description <string>` attaches a human-readable description to a CLI command's metadata.
#   • Annotation syntax — used together with `@ cli` to annotate entry points with metadata for CLI generation.
#
# Common mistakes:
#   • Using description without a corresponding @cli annotation — `@ description` only has meaning when attached to a `@ cli` entry point.
#
# See also: versio
# =============================================================================

# description — CLI description annotation
#
# GRAMMAR:
#   annotation :← '@' 'description' stringLit
#
# EXPECTED OUTPUT:
#   No main — declaration or test-runner surface only.
#
# BACKEND:
#   declaration-only CLI metadata (whitelist: description/descriptio.fab).
#

@ cli "descriptio-smoke"
@ description "Short CLI description"
main args args {
}