type alias GuideOption

One legal value of the missing word.

A listing of bare names — the package list of level 0 — sets neither GuideOption.detail nor GuideOption.summary, and is flowed into columns instead of one row per name.

Properties

readonly
name: string

The word to type, e.g. png, pngFile or decode.

readonly
optional
detail: string

Short annotation shown in its own column, e.g. → PngFile.

readonly
optional
summary: string

One-line description, e.g. the first line of the coder's JSDoc.

Usage

import { type GuideOption } from "mod.ts";