Inline DMRG output in README example#24
Merged
Merged
Conversation
Follow-up to #23: the README example runs DMRG but doesn't show the resulting output. Add an inlined expected-output block (via Literate `#= ```…``` =#`) so readers can see what the code produces without running it locally. Output values taken from the legacy README.md that existed before the template migration. Regenerate README.md via itpkgfmt so it picks up the change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
README / examples/README.jl changes are user-visible (downstream readers see the example output block), so this is a substantive change that warrants a patch bump. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Follow-up to #23. The example in
examples/README.jlruns DMRG but doesn't show the resulting output — the README just shows the code. Add an inlined expected-output block (using Literate's#= \``…``` =#` idiom for "rendered but not executed") so readers can see what the code produces without running it.Output values taken from the legacy README.md that existed before the template migration.
Regenerate
README.mdviaitpkgfmtto pick up the change.A later ecosystem change to
ITensorFormattermay eventually flipLiterate.markdown(... execute = true)so that these outputs are produced automatically, but that's tracked separately (Projects/ITensorFormatter.jl/fixes_and_improvementsin ITensorDevelopmentPlans) and needs determinism handling first.Test plan
🤖 Generated with Claude Code