docs(config-settings): fix stale __config_toggle_* references in helper docstrings
This commit is contained in:
@@ -2,11 +2,11 @@
|
|||||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
# __config_toggle_apply <varname> <scope> <value>
|
# __config_settings_apply <varname> <scope> <value>
|
||||||
#
|
#
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
# Applies a state value to an opinionated-component variable in the given
|
# Applies a state value to an opinionated-component variable in the given
|
||||||
# scope, immediately and persistently. Used by config-toggle's Left/Right
|
# scope, immediately and persistently. Used by config-settings's Left/Right
|
||||||
# (and vim h/l) directional handlers so the set/erase logic lives in one
|
# (and vim h/l) directional handlers so the set/erase logic lives in one
|
||||||
# place. A value of "DEFAULT" erases the variable in that scope so the
|
# place. A value of "DEFAULT" erases the variable in that scope so the
|
||||||
# master switch / built-in default takes over again.
|
# master switch / built-in default takes over again.
|
||||||
@@ -17,7 +17,7 @@
|
|||||||
# ARGUMENTS
|
# ARGUMENTS
|
||||||
# varname Variable name without the $ prefix
|
# varname Variable name without the $ prefix
|
||||||
# scope "universal" or "session"
|
# scope "universal" or "session"
|
||||||
# value "on", "off", or "DEFAULT"
|
# value "on", "off", "DEFAULT", or any arbitrary string (universal scope only)
|
||||||
#
|
#
|
||||||
# RETURNS
|
# RETURNS
|
||||||
# 0 Always
|
# 0 Always
|
||||||
@@ -33,7 +33,7 @@ function __config_settings_apply
|
|||||||
# stderr is suppressed because setting a value in one scope while the
|
# stderr is suppressed because setting a value in one scope while the
|
||||||
# other scope already holds the same variable makes interactive fish
|
# other scope already holds the same variable makes interactive fish
|
||||||
# emit a shadowing warning ("set: successfully set universal 'X'; but a
|
# emit a shadowing warning ("set: successfully set universal 'X'; but a
|
||||||
# global by that name shadows it"). config-toggle intentionally edits
|
# global by that name shadows it"). config-settings intentionally edits
|
||||||
# both scopes independently, so the warning is expected noise — and if
|
# both scopes independently, so the warning is expected noise — and if
|
||||||
# it reached the terminal it would push the cursor down a row and
|
# it reached the terminal it would push the cursor down a row and
|
||||||
# corrupt the in-place panel redraw (leaving a stacked top border
|
# corrupt the in-place panel redraw (leaving a stacked top border
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
# __config_toggle_draw <cur_row> <cur_scope> <var1> ... <var8>
|
# __config_settings_draw <cur_row> <cur_scope> <var1> ... <var8>
|
||||||
#
|
#
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
# Renders the 16-line config-toggle TUI panel to stdout. Panel width and
|
# Renders the 16-line config-toggle TUI panel to stdout. Panel width and
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
# __config_toggle_get_val <varname> <scope>
|
# __config_settings_get_val <varname> <scope>
|
||||||
#
|
#
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
# Returns the current value of a named variable in the specified scope by
|
# Returns the current value of a named variable in the specified scope by
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
# __config_toggle_read_key
|
# __config_settings_read_key
|
||||||
#
|
#
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
# Reads a single keypress directly from the controlling terminal in raw
|
# Reads a single keypress directly from the controlling terminal in raw
|
||||||
|
|||||||
Reference in New Issue
Block a user