docs: document reexported band API - #86
Merged
ChrisRackauckas merged 1 commit intoAug 26, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://chatgpt.com/codex/tasks/019f4028-d2ae-7a12-aff0-7d996bd9c791
ChrisRackauckas
marked this pull request as ready for review
August 26, 2026 09:31
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
2 participants
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
Documents the public
BandandBandErrorbindings directly in FastAlmostBandedMatrices.jl, including exact fields, constructors, argument types, and doctested usage. Renders both entries in the API page and removes the soleapi_docs_kwargssuppression.The types are externally defined by BandedMatrices.jl. The companion source-definition documentation PR is JuliaLinearAlgebra/BandedMatrices.jl#507. The Fast docs build was validated with that branch developed locally; this draft should wait for the upstream docs change to merge and release.
Ignore until reviewed by @ChrisRackauckas.
Verification
GROUP=QA julia --project -e 'using Pkg; Pkg.test()'\n -QA/alloc_tests.jl: 11/11 passed\n -QA/qa.jl: 20/20 passed\n-julia --project=docs docs/make.jlwith the Fast branch and BandedMatrices PR checkout developed locally\n - doctests, document checks, and HTML rendering completed\n-julia --startup-file=no --project=. -e 'using Runic; ...'\n-typos --format brief src/FastAlmostBandedMatrices.jl docs/src/api.md docs/make.jl test/qa/qa.jl\n-git diff --check\n\n🤖 Generated with Claude Code\nhttps://chatgpt.com/codex/tasks/019f4028-d2ae-7a12-aff0-7d996bd9c791