Skip to content

Add error handling for result display #2876

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
asinghvi17 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add error handling for result display #2876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c19b86e
Add error handling for result display
asinghvi17 Feb 10, 2026
249b9ce
Fix formatting and add changelog entry
asinghvi17 Feb 11, 2026
2e4446c
Merge branch 'master' into asinghvi17-patch-1
fingolfin Feb 15, 2026
8a5417c
Fix dict syntax for when an error happens during display
asinghvi17 Mar 3, 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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Added `Remotes.Forgejo` for specifying a `Remote` hosted on a Forgejo instance (such as codeberg.org). ([#2857])
* Doctests now default to the `parser_for_module` of the module that the docstring appears in, allowing modules that set their syntax version via `Base.Experimental.@set_syntax_version` to have their doctests parsed with the correct syntax automatically. Also added support for `DocTestSyntax` metadata and per-block `syntax=` attributes to explicitly specify a syntax version. ([#2874])

### Fixed

* Added error handling for `@example` block result display to avoid crashing when `display_dict` fails. ([#2876])

### Changed

* reduced time complexity from O(n^2) to O(n) to improve the initial load time for search ([#2875])
Expand Down
7 changes: 6 additions & 1 deletion src/expander_pipeline.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -905,7 +905,12 @@ function Selectors.runner(::Type{Expanders.ExampleBlocks}, node, page, doc)
input = droplines(x.code)

# Generate different in different formats and let each writer select
output = Base.invokelatest(Documenter.display_dict, result, context = :color => ansicolor)
output = try
Base.invokelatest(Documenter.display_dict, result, context = :color => ansicolor)
catch err
@error "Problem displaying result on page $(page.source): $(err)"
Dict(MIME"text/plain"() => "Error displaying result")
end
# Remove references to gensym'd module from text/plain
m = MIME"text/plain"()
if haskey(output, m)
Expand Down
Loading