fix(docs): strip backticks from Section 5 verbatim EXIT STATUS/ARGUMENTS lines #138

2026-09-08T16:42:58Z

rootiest commented

2026-09-08 16:42:58 +00:00

What

docs/verify-manual.py's test_concat_section_five_stays_verbatim has been failing in build-docs CI since before PR #133 merged (confirmed identical failure on 31b89b, the commit before #133). Section 5 (function manpages) is pandoc-rendered verbatim, so a backtick inside an EXIT STATUS or ARGUMENTS line renders as a literal backtick character on the page instead of markup — the test catches exactly that.

CI's log only ever showed 3 of the 7 actual offending lines (the assertion truncates to offenders[:3]). Ran the check locally and enumerated all of them.

Fix

Reworded 9 backtick-quoted commands to plain text across 6 files, matching how each function's own DESCRIPTION already refers to the same command:

functions/check_fish_deps.fish — `fish-deps status` → fish-deps status
functions/lock.fish — `loginctl lock-session` → loginctl lock-session
functions/cleanup.fish — `sudo pacman -Rns` → sudo pacman -Rns
functions/claude-pr.fish, functions/claude-docs.fish — `claude` → claude
functions/dops.fish — `docker ps` → docker ps (2 lines: ARGUMENTS and EXIT STATUS)
functions/ports.fish — `lsof` → lsof
functions/screensleep.fish — `busctl` → busctl
functions/steam-dl.fish — `steam` → steam

No behavior change — doc-comment text only.

Testing

python3 docs/verify-manual.py — 74/74 passed (was 73/74).

## What `docs/verify-manual.py`'s `test_concat_section_five_stays_verbatim` has been failing in `build-docs` CI since before PR #133 merged (confirmed identical failure on `31b89b`, the commit before #133). Section 5 (function manpages) is pandoc-rendered verbatim, so a backtick inside an EXIT STATUS or ARGUMENTS line renders as a literal backtick character on the page instead of markup — the test catches exactly that. CI's log only ever showed 3 of the 7 actual offending lines (the assertion truncates to `offenders[:3]`). Ran the check locally and enumerated all of them. ## Fix Reworded 9 backtick-quoted commands to plain text across 6 files, matching how each function's own DESCRIPTION already refers to the same command: - `functions/check_fish_deps.fish` — `` `fish-deps status` `` → `fish-deps status` - `functions/lock.fish` — `` `loginctl lock-session` `` → `loginctl lock-session` - `functions/cleanup.fish` — `` `sudo pacman -Rns` `` → `sudo pacman -Rns` - `functions/claude-pr.fish`, `functions/claude-docs.fish` — `` `claude` `` → `claude` - `functions/dops.fish` — `` `docker ps` `` → `docker ps` (2 lines: ARGUMENTS and EXIT STATUS) - `functions/ports.fish` — `` `lsof` `` → `lsof` - `functions/screensleep.fish` — `` `busctl` `` → `busctl` - `functions/steam-dl.fish` — `` `steam` `` → `steam` No behavior change — doc-comment text only. ## Testing `python3 docs/verify-manual.py` — 74/74 passed (was 73/74).

rootiest added 1 commit 2026-09-08 16:42:59 +00:00

fix(docs): strip backticks from Section 5 verbatim EXIT STATUS/ARGUMENTS lines 91dabd565c

Section 5 (function manpages) is pandoc-rendered verbatim, so a backtick
there is a literal character on the page, not markup. Nine EXIT STATUS/
ARGUMENTS lines across check_fish_deps, lock, cleanup, claude-pr,
claude-docs, dops, ports, screensleep, and steam-dl quoted a command with
backticks; reworded to plain text matching each function's own DESCRIPTION
style.

Fixes docs/verify-manual.py's test_concat_section_five_stays_verbatim,
failing in CI since before this branch (pre-existing on main, confirmed
against the commit before PR #133 merged).

rootiest merged commit fb454da3bc into main

2026-09-08 16:44:12 +00:00

rootiest deleted branch fix/docs-verbatim-backticks

2026-09-08 16:44:13 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/fish-config#138