Skip to content

📚 DOCS: Document renderer constructor differences - #421

Merged
chrisjsewell merged 2 commits into
executablebooks:masterfrom
user01010111:docs/renderer-constructor
Sep 9, 2026
Merged

📚 DOCS: Document renderer constructor differences#421
chrisjsewell merged 2 commits into
executablebooks:masterfrom
user01010111:docs/renderer-constructor

Conversation

@user01010111

Copy link
Copy Markdown
Contributor

Document that MarkdownIt passes itself to renderer_cls, unlike the argument-free JavaScript renderer constructor. Clarify the custom constructor contract and that RendererHTML accepts but ignores an optional parser argument.

Closes #127.

Validation: 981 tests passed; all pre-commit checks passed; strict docs build passed on Python 3.10 with Sphinx 8.1.3. Sphinx 9 fails in the unchanged API-doc configuration on both upstream and this branch.

@codecov

codecov Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.85%. Comparing base (bff75ed) to head (935bc0f).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #421   +/-   ##
=======================================
  Coverage   95.85%   95.85%           
=======================================
  Files          64       64           
  Lines        3619     3619           
=======================================
  Hits         3469     3469           
  Misses        150      150           
Flag Coverage Δ
pytests 95.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@chrisjsewell chrisjsewell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

@chrisjsewell
chrisjsewell merged commit 0198992 into executablebooks:master Sep 9, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document renderer class init difference in port.yaml

2 participants