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:
+12
-1
@@ -1,7 +1,18 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# bash switches to bash shell
|
||||
# SYNOPSIS
|
||||
# bash [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Switches the current shell session to bash, loading config from the XDG
|
||||
# config directory. Resets $SHELL back to fish on exit.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments passed through to the bash command
|
||||
#
|
||||
# EXAMPLE
|
||||
# bash
|
||||
function bash --wraps='bash' --description 'bash switches to bash shell'
|
||||
set SHELL $(which bash) # Set shell to bash
|
||||
command bash --rcfile "$XDG_CONFIG_HOME/bash/bashrc" $argv # Run bash
|
||||
|
||||
Reference in New Issue
Block a user