Skip to content

docs: fix typos in Sphinx documentation and probe/report strings - #2130

Open
xieyanran wants to merge 1 commit into
NVIDIA:mainfrom
xieyanran:fix/docs-typos-sphinx
Open

docs: fix typos in Sphinx documentation and probe/report strings#2130
xieyanran wants to merge 1 commit into
NVIDIA:mainfrom
xieyanran:fix/docs-typos-sphinx

Conversation

@xieyanran

Copy link
Copy Markdown

What changed

Fixes 13 spelling errors across 7 files:

  • docs/source/configurable.rst: overriden -> overridden, aggregrated -> aggregated
  • docs/source/faster.rst: parallise -> parallelize, taht -> that, form -> from, parallization -> parallelization (heading, underline length adjusted to match)
  • docs/source/generators/guardrails.rst: warpping -> wrapping, parallisation -> parallelisation
  • docs/source/reporting.calibration.rst: whiile -> while, artifically -> artificially
  • docs/source/translation.rst: entires -> entries
  • garak/analyze/report_avid.py: Vunerability -> Vulnerability (report description string; the sibling branch two lines below already spells it correctly)
  • garak/probes/tap.py: Therefor -> Therefore (module docstring)

Why

Found while reading through the Sphinx docs and a couple of module docstrings; these are plain prose/string typos that don't affect any behavior.

How I checked

  • Manually reviewed each change in context to avoid false positives (e.g. left British-English spelling variants like co-ordinate alone, and did not touch the DAN-mode jailbreak prompt text in dan.py, since those "typos" are part of the actual attack payload being tested, not documentation).
  • Confirmed no test in tests/ references any of the changed strings (grep -rn for each old string returned nothing).
  • Where a fix changed an RST section heading (faster.rst), verified the underline length still matches the new heading length so Sphinx won't warn about a mismatched title underline.

Signed-off-by: xieyanran <030728xyr@gmail.com>
@xieyanran
xieyanran force-pushed the fix/docs-typos-sphinx branch from d04baf9 to 982e45a Compare August 29, 2026 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant