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:
@@ -1,7 +1,24 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Function to capture colorized scrollback before exiting, with pruning and safe overrides
|
||||
# SYNOPSIS
|
||||
# smart_exit [-h] [-n]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Closes the shell session, capturing and archiving the terminal scrollback
|
||||
# log before exit (Kitty only). Automatically prunes junk and excess log
|
||||
# files according to $SCROLLBACK_HISTORY_MAX_FILES.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# -h, --help Show help message
|
||||
# -n, --no-log Exit without saving a scrollback log
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Shell session exited
|
||||
# 1 Argument parsing failed
|
||||
#
|
||||
# EXAMPLE
|
||||
# smart_exit --no-log
|
||||
function smart_exit --description 'Capture colorized scrollback before exiting, with pruning and safe overrides'
|
||||
set -l options h/help n/no-log
|
||||
argparse $options -- $argv
|
||||
|
||||
Reference in New Issue
Block a user