Files
fish-config/functions/config-toggle.fish
T
rootiest e651566e14 docs(functions): split RETURNS into EXIT STATUS and stdout RETURNS
RETURNS previously conflated fish's $status exit code with genuine
stdout/printed output, e.g. rm listing "0/1" as if they were print
values rather than exit codes. Rename RETURNS to EXIT STATUS across
all 83 documented functions, and reintroduce RETURNS as a distinct
label reserved for the 15 functions that actually print to stdout.

Update build-manual.py's ENTRY_HEADS to render Exit Status before
Returns, manualtools.py's SECTIONS constant, and AGENTS.md's label
order and label-usage guidance to match. Add two verify-manual.py
regression tests: EXIT STATUS bodies must never contain stray
stdout/printed language, and Returns: must always render after
Exit Status: when both are present. Regenerate docs/fish-config.md.
2026-07-26 16:41:57 -04:00

29 lines
721 B
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# CATEGORY
# 14-miscellaneous
#
# DEPENDENCIES
# config-settings
#
# SYNOPSIS
# config-toggle [args...]
#
# DESCRIPTION
# Deprecated alias for config-settings. Prints a one-line deprecation
# notice to stderr, then delegates all arguments to config-settings.
#
# ARGUMENTS
# args Passed through verbatim to config-settings
#
# EXIT STATUS
# Same as config-settings
#
# EXAMPLE
# config-toggle # opens config-settings with a deprecation notice
function config-toggle --description 'Deprecated alias for config-settings'
echo "config-toggle is deprecated, use config-settings instead" >&2
config-settings $argv
end