Module documentation 

The Documentation view: what a catalog says of one dataset, and what the format spec that reads a file says of it, as a page to read.

Ctrl+E on a home row opens it full screen; the Info panel’s Documentation tab draws the same page for the open dataset. A catalog’s word comes first: its description, its links, and a column’s description, unit and legend each stand over the spec’s. Fields are label value lines, each link is a line of its own that is cut with … rather than wrapped (y copies it whole), and a column’s value legend opens under it with Enter.

Structs

DocState

The view’s state: the page shown, where the cursor is, which legends are open.

Documented

What a page documents: a catalog’s dataset, what the format spec that reads the file says of it, or both.

Enums

DocLine

One line of the page, before it is laid out to a width.

Functions

lines

The page’s lines for doc, with the legends of expanded columns open. measured is the size something has measured, if any.

render_page

Draw the page in area (no frame): what the Info tab and the full-screen view share. Keeps the cursor’s line in view.

render_view

The full-screen view: the page in a frame titled with the dataset’s name, and the keys that work on it.