maintenance: raw-string the LaTeX-carrying docstrings - #145
Merged
Conversation
Non-raw docstrings containing LaTeX are corrupted by Python's escape handling.
Two distinct failure classes, and only the first is visible:
warned `\s`, `\l`, `\[` ... escapes Python does NOT recognise. It leaves
them literal but emits SyntaxWarning on every compile/import, and
they are slated to become a SyntaxError.
silent `\t` in `\theta`, `\f` in `\frac`, `\r` in `\rm`, `\b` in `\beta`.
Escapes Python DOES recognise: the value is corrupted with NO
diagnostic at all. `\theta_E` was literally TAB + "heta_E".
2 literals across 2 files get the `r` prefix. Both sweeps now return zero.
Verified, not assumed:
- Runtime values: 1 corruptions repaired, 0 other changes. Every changed
literal's value was compared HEAD vs worktree; the prefix may only ever
REMOVE corruption, never alter a string otherwise.
- Regenerated with autohands: notebooks/, markdown/, llms-full.txt and workspace_index.json are ALL byte-identical -- the diff-empty gate passes exactly.
Left deliberately alone: scripts/cookbooks/samples.py:410 carries " \\[-2pt]",
an ALREADY-escaped LaTeX line break. Raw-ifying it would double the backslash
and change the rendered LaTeX. It emits no warning and corrupts nothing.
Prose is untouched -- only the delimiter gains an `r`. Deliberate escapes were
left alone (real newlines in print(), already-escaped LaTeX line breaks): the
prefix was applied only where every backslash sits in a LaTeX context.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of PyAutoLabs/autolens_workspace#491 — one of six independent, prose-only PRs (one per workspace repo). No API surface, so no cross-repo merge ordering.
Non-raw docstrings containing LaTeX are corrupted by Python's escape handling, in two classes — and only one of them is visible:
\s,\l,\[— escapes Python does not recogniseSyntaxWarningper compile; slated to becomeSyntaxError\tin\theta,\fin\frac,\rin\rm2 literals across 2 files get the
rprefix — the smallest of the six. Both sweeps now return zero. Prose is untouched — only the delimiter gains anr.Verification
notebooks/,markdown/,llms-full.txtandworkspace_index.jsonare all byte-identical — the diff-empty gate passes exactly.scripts/cookbooks/configs.pyneeded a hand-approved prefix: its\sigmaand\lambdaare LaTeX label values in a YAML config example, with no math delimiters for the automatic matcher to key off. Read and confirmed before applying.Left alone deliberately
scripts/cookbooks/samples.py:410carries" \\[-2pt]"— an already-escaped LaTeX line break. In a non-raw literal that is one literal backslash, i.e. correct; addingrwould double it and change the rendered LaTeX. It emits no warning and corrupts nothing.More generally the prefix was applied only where every backslash sits in a LaTeX context, with an absolute veto on
\\, escaped quotes and numeric escapes regardless of context.Unblocked by PyAutoHands#251, which taught the notebook and env parsers to accept an
r"""opener.🤖 Generated with Claude Code
https://claude.ai/code/session_01MTjtx5mdituitiyQYFGn2E
Generated by Claude Code