Skip to content

Commit 955654f

Browse files
m-messerclaude
andcommitted
docs: clarify $$-on-its-own-line is our convention, not a KaTeX rule
The module docstring attributed this formatting rule to KaTeX itself; it's actually just this project's authoring convention. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent f08f4df commit 955654f

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

‎in2lambda/validation/delimiters.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
"""Checks that ``$ ... $`` and ``$$ ... $$`` math delimiters are balanced and placed correctly.
22
3-
KaTeX (and Lambda Feedback) expect inline math wrapped in single dollar signs on
4-
one line, and display math wrapped in ``$$`` that each sit alone on their own
5-
line. This module scans markdown character by character and reports the first
6-
delimiter mistake it finds.
3+
Lambda Feedback renders inline math (via KaTeX) wrapped in single dollar
4+
signs, and display math wrapped in ``$$``. Requiring each ``$$`` delimiter to
5+
sit alone on its own line is this project's own authoring convention, not a
6+
KaTeX requirement. This module scans markdown character by character,
7+
skipping fenced and inline code, and reports every delimiter mistake it
8+
finds together with the line it occurred on.
79
"""
810

911
from dataclasses import dataclass

0 commit comments

Comments
 (0)