feat: Add caption parameter to Report.code and simplify callers#20
Merged
Conversation
Add an optional caption parameter to Report.code(), exception(), and traceback() methods. When provided, the code block is wrapped in a container node with literal-block-wrapper class and a caption child, similar to .. code-block::'s :caption: option. Refactor all report.text() + report.code() and report.text() + report.exception() pairs in ctxnodes.py and jinja.py to use the new caption parameter directly. Co-authored-by: DeepSeek <service@deepseek.com>
SilverRainZ
force-pushed
the
feat/report-caption
branch
from
cbc3dd7 to
85cff62
Compare
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
1 participant
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
captionparameter toReport.code(),Report.exception(), andReport.traceback()captionis provided, the literal block is wrapped in a<container>withliteral-block-wrapperclass and a<caption>child node, similar to.. code-block::'s:caption:optionreport.text(...) + report.code(...)andreport.text(...) + report.exception(...)pairs inctxnodes.pyandjinja.pyto use the newcaptionparameter directlyCloses # (if applicable)