Skip to content

fix: protect backtick spans before stripping markdown italic in docstring generator #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bucknalla merged 1 commit into from
May 26, 2026
Merged

fix: protect backtick spans before stripping markdown italic in docstring generator #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions scripts/generate_apis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,23 @@ def clean_docstring_text(self, text: str) -> str:
import re
text = re.sub(r'\[([^\]]+)\]\([^\)]+\)', r'\1', text)

# Remove markdown emphasis formatting (* and _)
# Handle both single and double emphasis markers
# Remove markdown emphasis formatting (* and _), but protect backtick-quoted
# spans first so identifiers like SERIAL_RX_BUFFER_SIZE are not corrupted.
placeholders = {}
def save_backtick(m):
key = f"\x00BACKTICK{len(placeholders)}\x00"
placeholders[key] = m.group(0)
return key
text = re.sub(r'`[^`]*`', save_backtick, text)

text = re.sub(r'\*\*([^*]+)\*\*', r'\1', text) # **bold** -> bold
text = re.sub(r'\*([^*]+)\*', r'\1', text) # *italic* -> italic
text = re.sub(r'__([^_]+)__', r'\1', text) # __bold__ -> bold
text = re.sub(r'_([^_]+)_', r'\1', text) # _italic_ -> italic

for key, val in placeholders.items():
text = text.replace(key, val)

# Collapse multiple spaces into single spaces
text = re.sub(r'\s+', ' ', text)

Expand Down
Loading