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,18 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Substitutes text in the command line using the ^old^new pattern from the previous command
|
||||
# SYNOPSIS
|
||||
# __substitute_typo
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Reads the commandline buffer and applies ^old^new substitution against
|
||||
# the most recent history entry, replacing the buffer with the expanded
|
||||
# result. If the buffer does not match the ^old^new pattern, inserts a
|
||||
# literal caret character instead. Intended to be bound to ^ in
|
||||
# key_bindings.fish.
|
||||
#
|
||||
# EXAMPLE
|
||||
# bind ^ __substitute_typo
|
||||
function __substitute_typo
|
||||
set -l cursor_pos (commandline -C)
|
||||
set -l cmd (commandline)
|
||||
|
||||
Reference in New Issue
Block a user