Skip to content

[codex] update overlap docs example and local resolve note#137

Merged
terasakisatoshi merged 1 commit intomainfrom
codex/fix-doc-overlap-example
Apr 5, 2026
Merged

[codex] update overlap docs example and local resolve note#137
terasakisatoshi merged 1 commit intomainfrom
codex/fix-doc-overlap-example

Conversation

@terasakisatoshi
Copy link
Copy Markdown
Member

Summary

  • update the public overlap examples in the README and guide to use the current overlap(basis.v, ρ₀) form
  • add a short development note explaining that Pkg.resolve() can recover from a stale local Manifest.toml
  • keep the PR scope limited to the three requested documentation files

Why

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.jl
  • JULIA_DEPOT_PATH=$PWD/.codex-julia-depot julia --project=.tmp/test-feature-env -e 'using Pkg; Pkg.test("SparseIR")'

@terasakisatoshi terasakisatoshi enabled auto-merge (squash) April 5, 2026 04:18
@terasakisatoshi terasakisatoshi merged commit edbb35a into main Apr 5, 2026
15 checks passed
@terasakisatoshi terasakisatoshi deleted the codex/fix-doc-overlap-example branch April 5, 2026 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README and guide use obsolete overlap broadcasting form in main example

1 participant