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:
+16
-1
@@ -1,7 +1,22 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# alias clonet=clone-in-kitty --type=tab
|
||||
# SYNOPSIS
|
||||
# clonet [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Alias for clone-in-kitty --type=tab that clones a repository into a new
|
||||
# Kitty terminal tab. Only works inside the Kitty terminal.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to clone-in-kitty (typically a repo URL)
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Repository cloned
|
||||
# 1 Not running inside Kitty terminal
|
||||
#
|
||||
# EXAMPLE
|
||||
# clonet https://github.com/user/repo.git
|
||||
function clonet --wraps='clone-in-kitty --type=tab' --description 'alias clonet=clone-in-kitty --type=tab'
|
||||
if test "$TERM" != xterm-kitty
|
||||
echo "Error: The 'clonet' command requires Kitty terminal." >&2
|
||||
|
||||
Reference in New Issue
Block a user