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:
+13
-1
@@ -1,7 +1,19 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Alias ssh to kitten ssh when using Kitty terminal
|
||||
# SYNOPSIS
|
||||
# ssh [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Wraps ssh with kitten ssh inside Kitty terminal for better terminal
|
||||
# integration (e.g. terminfo forwarding). Falls back to system ssh on
|
||||
# other terminals.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to kitten ssh or system ssh
|
||||
#
|
||||
# EXAMPLE
|
||||
# ssh user@host
|
||||
function ssh --description 'Alias ssh to kitten ssh when using Kitty terminal'
|
||||
if test "$TERM" = xterm-kitty
|
||||
kitten ssh $argv
|
||||
|
||||
Reference in New Issue
Block a user