Skip to main content

note

Function note 

Source
pub(crate) fn note(heading: &str, rows: &[(&str, String)])
Expand description

A short human summary on stderr, when a person is looking.

Never on stdout. The commands that call this answer with JSON, and that JSON is read by agents, jq, and the tests – so it stays byte for byte what it was, whatever is attached. This is the second audience: someone at a prompt who has just run their first choir command and would otherwise be reading a brace.

Nothing here is load-bearing. A reader who redirects stderr loses decoration and no information: every field printed is already in the document on stdout.