docs(functions): add missing EXIT STATUS header docs

Fills the gaps recorded in JOB-BRIEF-FINDINGS.md for the functions
converted to header-driven --help: 16 argument-less functions gain an
EXIT STATUS section (check_fish_deps, claude-docs, claude-pr, cleanup,
fast, fzf-update, gip, gip4, hist, limine-edit, lock, ports,
screensleep, steam-dl, swapstat, tmux-clean), and 8 functions that
already document ARGUMENTS gain EXIT STATUS too (lD, lsr, lss, lstree,
lt, ltr, lx, qr).

Not touched: gip6, ld, parur, sudo-toggle, upgrade, the JOB-BRIEF's
'missing ARGUMENTS' group. Re-checked their bodies against that claim
-- none of the five take a positional argument ($argv only appears
forwarded to the --help check), so an ARGUMENTS section would document
something that doesn't exist. All five already have EXIT STATUS.

This commit is contained in:

rootiest

2026-09-08 01:12:04 -04:00

parent 3aa462a2b8

commit dccf897c9f

24 changed files with 75 additions and 0 deletions

									
										functions/swapstat.fish
									
		+3
		
												View File
												
				@@ -12,6 +12,9 @@

				#   zRAM compression ratio, zRAM device details (via zramctl), and

				#   active swap priority (via swapon).

				#

				# EXIT STATUS

				#   0  Always

				#

				# EXAMPLE

				#   swapstat

				function swapstat --description 'View colorized zRAM and swappiness status'