Skip to content

fix: escape underscores in docstring markdown titles #422

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

Open
kapsner wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: escape underscores in docstring markdown titles #422

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58fea80
fix: sanitize docstring anchors
kapsner Feb 6, 2026
a2c1cad
fix: reverted prev change and escape underscore on dispname
kapsner Feb 6, 2026
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
2 changes: 1 addition & 1 deletion quartodoc/renderers/md_renderer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ def signature(
@dispatch
def render_header(self, el: layout.Doc) -> str:
"""Render the header of a docstring, including any anchors."""
_str_dispname = el.name
_str_dispname = str(el.name).replace("_", "\\_")

# TODO: support anchors that are not fully qualified paths?
# e.g. get_object, rather than quartodoc.get_object
Expand Down