Ghost Description

Definition

The description is the free-text field that documents intent, context, or pending work tied to a symbol or to an anchor.

Example

// @ghost description: this method does not handle refresh tokens yet | status: todo
function login() {}

Tree result:

login   (todo): this method does not handle refresh tokens yet

There is no format constraint on the text. It can be a short sentence, a ticket reference, or a longer architectural note.

Next step

Continue with Anchor to understand the difference between metadata attached to a symbol and a node with its own identity.