descriptio
Translation status: हिन्दी reader-locale proof. Code fences render through the hi pipeline; prose is canonical Latin.
Attaches a description string to CLI metadata.
Syntax: @ descriptio <string>
Category#
cli
Related#
Examples#
radix/corpus/descriptio/descriptio.fab (canonical · keyword)#
Attaches a description string to CLI metadata.
# =============================================================================
# descriptio — Attaches a description string to CLI metadata.
# =============================================================================
#
# What this teaches:
# • CLI metadata — `@ descriptio <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 descriptio without a corresponding @cli annotation — `@ descriptio` only has meaning when attached to a `@ cli` entry point.
#
# See also: versio
# =============================================================================
# descriptio — CLI description annotation
#
# GRAMMAR:
# annotation :← '@' 'descriptio' stringLit
#
# EXPECTED OUTPUT:
# No incipit — declaration or test-runner surface only.
#
# BACKEND:
# declaration-only CLI metadata (whitelist: descriptio/descriptio.fab).
#
@ cli "descriptio-smoke"
@ description "Short CLI description"
main args args {
}