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