fix: protect backtick spans before stripping markdown italic in docstring generator#175
Merged
Bucknalla merged 1 commit intoMay 26, 2026
Conversation
…ring generator The _([^_]+)_ regex intended to strip _italic_ markdown was also matching underscores inside backtick-quoted identifiers (e.g. SERIAL_RX_BUFFER_SIZE → SERIALRXBUFFER_SIZE). Backtick spans are now saved and restored around the emphasis-stripping pass. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
zfields
approved these changes
May 26, 2026
Bucknalla
deleted the
alex-fix-docstring-italic-regex-corrupting-identifiers
branch
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.
Summary
clean_docstring_textmethod inscripts/generate_apis.pywas applying a_([^_]+)_regex to strip markdown italic formatting, but this also matched underscores inside backtick-quoted identifiersSERIAL_RX_BUFFER_SIZE→SERIALRXBUFFER_SIZEbecause_RX_was treated as italic markdown and strippedThis is the root cause behind #174 — the upstream schema has always had the correct
SERIAL_RX_BUFFER_SIZE, but the generator was corrupting it on every automated build run.Test plan
SERIAL_RX_BUFFER_SIZEis preserved innotecard/card.pyafter runningpipenv run python scripts/generate_apis.py --output-dir notecard_italic_outside of backticks is still stripped correctly🤖 Generated with Claude Code