Conversation
mtfishman
force-pushed
the
auto-format-pr
branch
from
e114160 to
5365bea
Compare
mtfishman
added a commit
that referenced
this pull request
Apr 25, 2026
## Summary - The previous `examples/README.jl` was the bare ITensorPkgSkeleton template stub (added to unblock the docs build, since `make_index!` requires that input file). Every `itpkgfmt` run regenerated `README.md` from the stub, which was about to wipe the actual usage prose and `@visualize` examples that lived in `README.md` on main — see #18 for the regeneration that captured the deletion. - This PR moves the description, the UnicodePlots contraction example, the GLMakie backend example, and the backend-switching session into `examples/README.jl` as Literate input. The contraction setup and both `@visualize` calls are bare Julia so they execute as part of the shared `ITensorPkgSkeleton.runtests` examples sweep. Output blocks (ASCII art, GLMakie window snippet, `julia>` prompts) stay wrapped in `#= ... =#` so they pass through as raw markdown without trying to execute. - Image references switch to absolute `raw.githubusercontent.com` URLs so the same source renders correctly in both `README.md` and `docs/src/index.md`. Closes #18. --------- 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.
Automated changes by create-pull-request GitHub action