Skip to content

Fit the help in 80 columns and fill gaps in the docs - #34

Merged
bbatsov merged 4 commits into
mainfrom
docs-polish
Oct 21, 2026
Merged

bbatsov merged 4 commits into
mainfrom
docs-polish

Conversation

@bbatsov

@bbatsov bbatsov commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

The help wraps option descriptions to fit in 80 columns, with a test over every command, and complete exits 1 when nothing completes, like the other lookups. The README gets the inspector's P and g, and the skill covers several servers, restarts and what exit 1 means.

complete --format json with nothing to complete returns a not-found object now rather than [], matching apropos.

Options with long descriptions, like --tool, --session and mcp's
--timeout, ran past 80 columns, up to 110, and wrapped wherever the
terminal broke them. The summary wraps each description under itself
now, and a test checks every command's help, the inspect usage line
included, which got split in two.
neorepl complete printed nothing and exited 0 for a prefix with no
completions, where apropos, doc and the other lookups exit 1 when they
find nothing, and neither its help nor macroexpand's had an exit status
paragraph. complete reports not-found the way the lookups do now, in
every format, and a server with no completion op says so rather than
passing for one with nothing to complete. Both helps say what the
statuses mean.
The README listed the full-screen inspector's keys but left out P, which
turns pretty printing on and off, and g, which shows the value again,
while the inspector's own help line has them, and the arrows that do what
Enter and Backspace do. It also said neorepl inspect does the same, which
it does for pushing, popping, paging and defining only.
The skill didn't say which server the commands use when there are
several, or that -p picks another, nor what happens to the agent session
when the server restarts, usually on another port, and it gave exit 1 as
the code, a test or check failing only, where a lookup finding nothing
and a server failing to start exit 1 too.
@bbatsov
bbatsov merged commit 325e940 into main Oct 21, 2026
18 checks passed
@bbatsov
bbatsov deleted the docs-polish branch October 21, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant