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:
2026-06-05 20:18:49 -04:00
parent 0396d685fd
commit 1341e2559e
108 changed files with 1520 additions and 148 deletions
@@ -1,6 +1,17 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# SYNOPSIS
# __auto_source_fallback_venv
#
# DESCRIPTION
# Event handler that auto-activates a .venv Python virtual environment when
# entering a directory. Deactivates when leaving the project tree. Skipped
# when direnv is already managing the directory.
#
# EXAMPLE
# # Triggered automatically on directory change; not called directly.
# cd ~/myproject # activates .venv if present
function __auto_source_fallback_venv --on-variable PWD
status --is-command-substitution; and return