Skip to content

Switch back from @repl to jldoctest blocks in docstrings#217

Merged
Luis-Varona merged 1 commit intomainfrom
repl-to-jldoctest
Jan 29, 2026
Merged

Switch back from @repl to jldoctest blocks in docstrings#217
Luis-Varona merged 1 commit intomainfrom
repl-to-jldoctest

Conversation

@Luis-Varona
Copy link
Copy Markdown
Owner

Since Documenter.jl stopped executing @repl blocks in the generated documentation, we switch back from @repl to jldoctest blocks in the docstrings so that users can still see the expected output in the REPL and in the source code.

@Luis-Varona Luis-Varona self-assigned this Jan 29, 2026
@Luis-Varona Luis-Varona added the documentation Improvements or additions to documentation label Jan 29, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Luis-Varona Luis-Varona force-pushed the repl-to-jldoctest branch 3 times, most recently from 65d3c4f to da90fe6 Compare January 29, 2026 08:25
Since Documenter.jl stopped executing @repl blocks in the generated documentation, we switch back from @repl to jldoctest blocks in the docstrings so that users can still see the expected output in the REPL and in the source code.
@Luis-Varona Luis-Varona merged commit cd78fd1 into main Jan 29, 2026
9 checks passed
@Luis-Varona Luis-Varona deleted the repl-to-jldoctest branch January 29, 2026 08:32
@Luis-Varona Luis-Varona mentioned this pull request Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant