[codex] update overlap docs example and local resolve note#137
Merged
terasakisatoshi merged 1 commit intomainfrom Apr 5, 2026
Merged
[codex] update overlap docs example and local resolve note#137terasakisatoshi merged 1 commit intomainfrom
terasakisatoshi merged 1 commit intomainfrom
Conversation
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
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
overlapexamples in the README and guide to use the currentoverlap(basis.v, ρ₀)formPkg.resolve()can recover from a stale localManifest.tomlWhy
The main public example still used an obsolete broadcasted
overlap.(basis.v, ρ₀)call, which no longer matches the current API and was reported in issue #136. While investigating that report, the local development flow also benefited from a short note about recovering from out-of-sync local manifests.Fixes #136.
Validation
JULIA_DEPOT_PATH=$PWD/.codex-julia-depot julia --project=.tmp/test-feature-env -e 'using Test; readme=read("README.md", String); guide=read(joinpath("docs","src","guide.md"), String); @test !occursin("overlap.(basis.v, ρ₀)", readme); @test !occursin("overlap.(basis.v, ρ₀)", guide); @test occursin("overlap(basis.v, ρ₀)", readme); @test occursin("overlap(basis.v, ρ₀)", guide); dev=read("development.md", String); @test occursin("Pkg.resolve()", dev); println("DOCS_VERIFY_OK")'JULIA_DEPOT_PATH=$PWD/.codex-julia-depot julia --project=.tmp/test-feature-env .tmp/test-feature/core_workflow.jlJULIA_DEPOT_PATH=$PWD/.codex-julia-depot julia --project=.tmp/test-feature-env -e 'using Pkg; Pkg.test("SparseIR")'