rootiest
a65e05b661
The man-page-style comment header above each function in functions/*.fish becomes the SSOT for that function's documentation. Writing a new function and documenting it are now the same act. - manualtools.parse_functions() parses every header carrying a # CATEGORY; absence of one is the opt-in, keeping bundled-plugin and prompt internals out of the manual with no exclusion list to maintain. - build-manual.py generates entries for both --concat and --site, with **Dependencies:** rendered as links and a **Used by:** reverse index computed in one pass. Cross-category links are the navigation win. - docs/manual/05-functions/*.md reduced to frontmatter-only stubs. Every intro measured zero words, so the category files were pure entry containers; ordering, titles, and helpKeywords routing are untouched. - _first_sentence() unwraps the leading hard-wrapped paragraph and skips the whole Synopsis block, not just its label line. Site cards no longer truncate mid-clause or show a synopsis as their description. Verification, per the design spec: - test_concat_roundtrips_original scoped to sections 0-4 and 6-11. It guarded a format migration; this is a content migration. - replaced by structural checks: one entry per categorised function, the required sections present, every category resolving to a stub with no stub empty, and every declared dependency resolving to a real function or a type -q-guarded binary. - public functions lacking # CATEGORY warn rather than fail, so a new user-facing function going undocumented stays visible in CI. 24/24 checks pass. 94 entries generated from 94 parsed headers. Also drops a stale claim from open-url's NOTES: config-help --html calls xdg-open directly and has never called open-url.
29 lines
717 B
Fish
29 lines
717 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
|
|
#
|
|
# RETURNS
|
|
# 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
|