Skip to content

docs: document Band and BandError - #507

Merged
ChrisRackauckas merged 3 commits into
JuliaLinearAlgebra:masterfrom
ChrisRackauckas-Claude:docs/document-band-api
Aug 26, 2026
Merged

docs: document Band and BandError#507
ChrisRackauckas merged 3 commits into
JuliaLinearAlgebra:masterfrom
ChrisRackauckas-Claude:docs/document-band-api

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown

Summary

Documents Band and BandError at their source definitions, including fields, arguments, and executable examples. Adds both names to the existing rendered API page.

This is the upstream dependency for FastAlmostBandedMatrices.jl removing its local public-doc QA suppression.

Ignore until reviewed by @ChrisRackauckas.

Verification

  • julia --project -e 'using Pkg; Pkg.test()'\n - Overall | 30727 passed, 5 broken, 30732 total\n- julia --project=docs docs/make.jl\n - Doctest, document checks, and HTML rendering completed. The existing build emitted six :missing_docs warnings under its pre-existing warnonly configuration.\n- typos --format brief src/generic/Band.jl docs/src/index.md\n- git diff --check\n\n🤖 Generated with Claude Code\nhttps://chatgpt.com/codex/tasks/019f4028-d2ae-7a12-aff0-7d996bd9c791

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
@codecov

codecov Bot commented Aug 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.13%. Comparing base (f5403f4) to head (15ca6e0).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master     #507       +/-   ##
===========================================
+ Coverage    0.00%   90.13%   +90.13%     
===========================================
  Files          25       27        +2     
  Lines        3714     3740       +26     
===========================================
+ Hits            0     3371     +3371     
+ Misses       3714      369     -3345     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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
ChrisRackauckas marked this pull request as ready for review August 26, 2026 14:50
@ChrisRackauckas
ChrisRackauckas merged commit a8e4257 into JuliaLinearAlgebra:master Aug 26, 2026
18 checks passed
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.

4 participants