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:
+17
-1
@@ -1,7 +1,23 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Spawn a new tab in the current terminal
|
||||
# SYNOPSIS
|
||||
# tab [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Opens a new tab in Kitty, WezTerm, or Konsole using the current
|
||||
# working directory (or $cdto if set). Arguments are forwarded to the
|
||||
# terminal's tab-open command.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to the terminal's launch command
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Tab opened successfully
|
||||
# 1 No supported terminal found
|
||||
#
|
||||
# EXAMPLE
|
||||
# tab
|
||||
function tab --description 'Spawn a new tab in the current terminal'
|
||||
set -l dir "$cdto"
|
||||
if test -z "$dir"
|
||||
|
||||
Reference in New Issue
Block a user