docs(functions): drop backticks from doc-headers
CONTRIBUTING states doc-headers are written as plain text -- the header is read as-is by config-help, by funcsave, and by anyone opening the file, and docs/codespans.py adds the site's inline code spans at render time. 22 files had drifted from that, carrying 41 hand-written spans that reached config-help and the man page as literal backtick characters inside an otherwise verbatim block. The one span whose content ended in a space is requoted rather than dropped, so "read> " keeps reading as a prompt string.
This commit is contained in:
@@ -7,11 +7,11 @@
|
||||
# DESCRIPTION
|
||||
# Reads a single keypress directly from the controlling terminal in raw
|
||||
# mode and echoes a normalized token naming the key. Bypasses fish's
|
||||
# `read` builtin, whose interactive line editor swallows Tab and arrow
|
||||
# keys (and prints a `read> ` prompt) — none of which is usable for a TUI.
|
||||
# read builtin, whose interactive line editor swallows Tab and arrow
|
||||
# keys (and prints a "read> " prompt) — none of which is usable for a TUI.
|
||||
#
|
||||
# The terminal is put into raw, no-echo mode with a 0.1s inter-byte timer
|
||||
# (`stty raw -echo min 1 time 1`) so a multi-byte escape sequence (e.g.
|
||||
# (stty raw -echo min 1 time 1) so a multi-byte escape sequence (e.g.
|
||||
# an arrow key, ESC [ A) is captured in one read while a lone key returns
|
||||
# promptly. Original terminal settings are always restored before return.
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user