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:
2026-09-08 01:12:04 -04:00
parent 3aa462a2b8
commit dccf897c9f
24 changed files with 75 additions and 0 deletions
+3
View File
@@ -11,6 +11,9 @@
# Backwards-compatibility wrapper that delegates to fish-deps status to # Backwards-compatibility wrapper that delegates to fish-deps status to
# report which fish shell dependencies are installed or missing. # report which fish shell dependencies are installed or missing.
# #
# EXIT STATUS
# Exit status of `fish-deps status`
#
# EXAMPLE # EXAMPLE
# check_fish_deps # check_fish_deps
function check_fish_deps --description 'Check all fish-related dependencies' function check_fish_deps --description 'Check all fish-related dependencies'
+3
View File
@@ -12,6 +12,9 @@
# README.md, ensuring all features and examples are accurate and pruning # README.md, ensuring all features and examples are accurate and pruning
# obsolete content. # obsolete content.
# #
# EXIT STATUS
# Exit status of the `claude` invocation
#
# EXAMPLE # EXAMPLE
# claude-docs # claude-docs
function claude-docs --description 'Claude-code: Sync README with recent changes' function claude-docs --description 'Claude-code: Sync README with recent changes'
+3
View File
@@ -12,6 +12,9 @@
# branch, write a Conventional Commit, run verification, push, and open a # branch, write a Conventional Commit, run verification, push, and open a
# pull request with a manual verification checklist. # pull request with a manual verification checklist.
# #
# EXIT STATUS
# Exit status of the `claude` invocation
#
# EXAMPLE # EXAMPLE
# claude-pr # claude-pr
function claude-pr --description 'Claude-code: New branch, commit, push, and PR' function claude-pr --description 'Claude-code: New branch, commit, push, and PR'
+4
View File
@@ -11,6 +11,10 @@
# Identifies and removes Arch Linux orphan packages using pacman. Logs # Identifies and removes Arch Linux orphan packages using pacman. Logs
# package names and versions to ~/.removed_orphans before removal. # package names and versions to ~/.removed_orphans before removal.
# #
# EXIT STATUS
# 0 No orphans found, or orphans removed successfully
# Nonzero `sudo pacman -Rns` failed
#
# EXAMPLE # EXAMPLE
# cleanup # cleanup
function cleanup --description 'Log orphans to ~/.removed_orphans and remove them' function cleanup --description 'Log orphans to ~/.removed_orphans and remove them'
+3
View File
@@ -33,6 +33,9 @@
# Displays a styled message indicating that the fast command is unavailable # Displays a styled message indicating that the fast command is unavailable
# and suggests using fast-cli instead. # and suggests using fast-cli instead.
# #
# EXIT STATUS
# 0 Always
#
# EXAMPLE # EXAMPLE
# fast # fast
function fast --description 'Placeholder for future fast utility' function fast --description 'Placeholder for future fast utility'
+4
View File
@@ -11,6 +11,10 @@
# Installs or upgrades fzf from git HEAD into ~/.fzf. Pulls the latest # Installs or upgrades fzf from git HEAD into ~/.fzf. Pulls the latest
# changes if ~/.fzf already exists, or clones the repository if not. # changes if ~/.fzf already exists, or clones the repository if not.
# #
# EXIT STATUS
# 0 fzf installed or updated successfully
# Nonzero git or the fzf install script failed
#
# EXAMPLE # EXAMPLE
# fzf-update # fzf-update
function fzf-update --description 'Install or upgrade fzf from git HEAD' function fzf-update --description 'Install or upgrade fzf from git HEAD'
+3
View File
@@ -11,6 +11,9 @@
# Fetches and prints both the public IPv4 and IPv6 addresses using # Fetches and prints both the public IPv4 and IPv6 addresses using
# icanhazip.com. Shows "Not detected" for any address that times out. # icanhazip.com. Shows "Not detected" for any address that times out.
# #
# EXIT STATUS
# 0 Always (network failures print "Not detected" instead of failing)
#
# EXAMPLE # EXAMPLE
# gip # gip
function gip --description 'Show all public IP addresses' function gip --description 'Show all public IP addresses'
+3
View File
@@ -10,6 +10,9 @@
# DESCRIPTION # DESCRIPTION
# Fetches and prints the machine's public IPv4 address using icanhazip.com. # Fetches and prints the machine's public IPv4 address using icanhazip.com.
# #
# EXIT STATUS
# Exit status of curl
#
# EXAMPLE # EXAMPLE
# gip4 # gip4
function gip4 --wraps='curl' --description 'Get public IPv4 address' function gip4 --wraps='curl' --description 'Get public IPv4 address'
+4
View File
@@ -14,6 +14,10 @@
# Searches fish history interactively using fzf, inserts the selected command # Searches fish history interactively using fzf, inserts the selected command
# into the command line, and copies it to the clipboard via wl-copy. # into the command line, and copies it to the clipboard via wl-copy.
# #
# EXIT STATUS
# 0 Command selected and inserted, or fzf was cancelled
# 1 Disabled by __fish_config_op_integrations
#
# EXAMPLE # EXAMPLE
# hist # hist
function hist --description 'Search fish history and put it in the prompt' function hist --description 'Search fish history and put it in the prompt'
+3
View File
@@ -14,6 +14,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# lD ~/projects # lD ~/projects
function lD --description 'List directories only' function lD --description 'List directories only'
+3
View File
@@ -13,6 +13,9 @@
# files tracked by sbctl. Combines the edit and sign steps into a single # files tracked by sbctl. Combines the edit and sign steps into a single
# command. # command.
# #
# EXIT STATUS
# 0 Always (individual step failures are not propagated)
#
# EXAMPLE # EXAMPLE
# limine-edit # limine-edit
function limine-edit --description 'Safely edit and re-verify Limine configuration' function limine-edit --description 'Safely edit and re-verify Limine configuration'
+3
View File
@@ -10,6 +10,9 @@
# DESCRIPTION # DESCRIPTION
# Locks the current desktop session using loginctl lock-session. # Locks the current desktop session using loginctl lock-session.
# #
# EXIT STATUS
# Exit status of `loginctl lock-session`
#
# EXAMPLE # EXAMPLE
# lock # lock
function lock --wraps='loginctl' --description 'alias lock=loginctl' function lock --wraps='loginctl' --description 'alias lock=loginctl'
+3
View File
@@ -14,6 +14,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# lsr ~/projects # lsr ~/projects
function lsr --description 'Reversed time-sorted listing' function lsr --description 'Reversed time-sorted listing'
+3
View File
@@ -14,6 +14,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# lss ~/downloads # lss ~/downloads
function lss --description 'Size-sorted listing' function lss --description 'Size-sorted listing'
+3
View File
@@ -14,6 +14,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# lstree ~/projects/myapp # lstree ~/projects/myapp
function lstree --description 'Full recursive tree listing' function lstree --description 'Full recursive tree listing'
+3
View File
@@ -14,6 +14,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# lt ~/projects # lt ~/projects
function lt --description 'Tree listing, depth 2' function lt --description 'Tree listing, depth 2'
+3
View File
@@ -15,6 +15,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# ltr ~/projects # ltr ~/projects
function ltr --description 'Reversed time-sorted listing' function ltr --description 'Reversed time-sorted listing'
+3
View File
@@ -14,6 +14,9 @@
# ARGUMENTS # ARGUMENTS
# args... Arguments forwarded to the listing command # args... Arguments forwarded to the listing command
# #
# EXIT STATUS
# Exit status of eza, lsd, or ls, whichever ran
#
# EXAMPLE # EXAMPLE
# lx ~/projects # lx ~/projects
function lx --description 'Extension-sorted listing' function lx --description 'Extension-sorted listing'
+3
View File
@@ -11,6 +11,9 @@
# Lists all active TCP listeners on the system using lsof, showing # Lists all active TCP listeners on the system using lsof, showing
# port numbers and addresses without hostname resolution. # port numbers and addresses without hostname resolution.
# #
# EXIT STATUS
# Exit status of `lsof`
#
# EXAMPLE # EXAMPLE
# ports # ports
function ports --wraps='sudo' --description 'Show active network listeners' function ports --wraps='sudo' --description 'Show active network listeners'
+3
View File
@@ -15,6 +15,9 @@
# ARGUMENTS # ARGUMENTS
# text... Text to encode; reads from stdin if omitted # text... Text to encode; reads from stdin if omitted
# #
# EXIT STATUS
# Exit status of qrencode, or curl if qrencode is unavailable
#
# EXAMPLE # EXAMPLE
# qr "https://example.com" # qr "https://example.com"
# echo "hello" | qr # echo "hello" | qr
+3
View File
@@ -11,6 +11,9 @@
# Turns off the display after a 1-second delay by invoking the KDE # Turns off the display after a 1-second delay by invoking the KDE
# PowerDevil "Turn Off Screen" global shortcut via busctl. # PowerDevil "Turn Off Screen" global shortcut via busctl.
# #
# EXIT STATUS
# Exit status of `busctl`
#
# EXAMPLE # EXAMPLE
# screensleep # screensleep
function screensleep --description 'Turn off the display using KDE PowerDevil' function screensleep --description 'Turn off the display using KDE PowerDevil'
+3
View File
@@ -11,6 +11,9 @@
# Launches Steam with systemd-inhibit to prevent the system from idling # Launches Steam with systemd-inhibit to prevent the system from idling
# or sleeping during active downloads. # or sleeping during active downloads.
# #
# EXIT STATUS
# Exit status of `steam` (via systemd-inhibit)
#
# EXAMPLE # EXAMPLE
# steam-dl # steam-dl
function steam-dl --description 'Run Steam while inhibiting system sleep' function steam-dl --description 'Run Steam while inhibiting system sleep'
+3
View File
@@ -12,6 +12,9 @@
# zRAM compression ratio, zRAM device details (via zramctl), and # zRAM compression ratio, zRAM device details (via zramctl), and
# active swap priority (via swapon). # active swap priority (via swapon).
# #
# EXIT STATUS
# 0 Always
#
# EXAMPLE # EXAMPLE
# swapstat # swapstat
function swapstat --description 'View colorized zRAM and swappiness status' function swapstat --description 'View colorized zRAM and swappiness status'
+3
View File
@@ -11,6 +11,9 @@
# Kills all detached (unattached) tmux sessions, leaving any currently # Kills all detached (unattached) tmux sessions, leaving any currently
# attached sessions running. # attached sessions running.
# #
# EXIT STATUS
# 0 Always
#
# EXAMPLE # EXAMPLE
# tmux-clean # tmux-clean
function tmux-clean --description 'Kill all tmux sessions except the current one' function tmux-clean --description 'Kill all tmux sessions except the current one'