docs(customization): convert Notes: list to a NOTE: callout paragraph
This commit is contained in:
@@ -123,17 +123,11 @@ For an interactive alternative to setting these variables by hand, run
|
||||
config-settings — a full-screen TUI that flips any category (including C5
|
||||
logging) on or off, per session or universally. See its entry in Section 5.
|
||||
|
||||
Notes:
|
||||
|
||||
- Command shadows (rm, cat, ls, ...) react immediately; conf.d-level
|
||||
components (bindings, prompt, abbreviations, hooks) take effect in
|
||||
new shells.
|
||||
- With aliases disabled, rm falls back to bare `command rm` — files
|
||||
are deleted permanently, not trashed.
|
||||
- Disabled integration commands (spwin, tab, split, hist, logs,
|
||||
upgrade) print an error naming the variable that disabled them.
|
||||
- On CachyOS, the distro fish config's own aliases, history override,
|
||||
and bang-bang bindings are stripped per category as well.
|
||||
NOTE:
|
||||
- Command shadows (rm, cat, ls, ...) react immediately; conf.d-level components (bindings, prompt, abbreviations, hooks) take effect in new shells.
|
||||
- With aliases disabled, rm falls back to bare `command rm` — files are deleted permanently, not trashed.
|
||||
- Disabled integration commands (spwin, tab, split, hist, logs, upgrade) print an error naming the variable that disabled them.
|
||||
- On CachyOS, the distro fish config's own aliases, history override, and bang-bang bindings are stripped per category as well.
|
||||
|
||||
### Component Reference
|
||||
|
||||
|
||||
@@ -665,6 +665,21 @@ def test_as_file_tree_rejects_non_trees():
|
||||
assert build_manual._as_file_tree(para) is None, f"{label} was wrongly treed"
|
||||
|
||||
|
||||
def test_customization_notes_render_as_aside():
|
||||
"""The real 07-customization.md NOTE paragraph converts to one intact <Aside>."""
|
||||
import build_manual
|
||||
|
||||
path = Path(__file__).parent / "manual" / "07-customization.md"
|
||||
_, body = mt.parse(path)
|
||||
out = build_manual.prettify(body)
|
||||
assert out.count('<Aside type="note" title="Note">') == 1, f"expected exactly one Note aside:\n{out}"
|
||||
assert "- Command shadows (rm, cat, ls, ...) react immediately" in out
|
||||
assert "- With aliases disabled, rm falls back to bare `command rm`" in out
|
||||
assert "- Disabled integration commands (spwin, tab, split, hist, logs, upgrade)" in out
|
||||
assert "- On CachyOS, the distro fish config's own aliases" in out
|
||||
assert "</Aside>" in out
|
||||
|
||||
|
||||
def test_prettify_is_site_only():
|
||||
"""The SSOT keeps the indented form the man-page pipeline depends on."""
|
||||
import build_manual
|
||||
|
||||
Reference in New Issue
Block a user