docs(functions): standardize all function doc blocks to UNIX man-page style
Replace all ad-hoc inline comments between license headers and function declarations with consistent SYNOPSIS / DESCRIPTION / ARGUMENTS / RETURNS / EXAMPLE blocks across all 99 project-owned functions/ files. No executable logic, variable names, or exit codes were modified. Completes Task #6 from AGENTS.md (Retroactive Function Documentation Standardization).
This commit is contained in:
+12
-1
@@ -1,7 +1,18 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# alias rawfish=env NO_TMUX=1 fish
|
||||
# SYNOPSIS
|
||||
# rawfish [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Launches a Fish shell with NO_TMUX=1 set, bypassing any tmux
|
||||
# auto-attach or session management hooks.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to fish
|
||||
#
|
||||
# EXAMPLE
|
||||
# rawfish
|
||||
function rawfish --wraps='env NO_TMUX=1 fish' --description 'alias rawfish=env NO_TMUX=1 fish'
|
||||
env NO_TMUX=1 fish $argv
|
||||
|
||||
|
||||
Reference in New Issue
Block a user