Documentation improvements: Expand examples and enhance docstrings#39
Merged
ChrisRackauckas merged 2 commits intoDec 30, 2025
Conversation
This prevents dependabot from creating PRs for every minor and patch version update of the typos tool, reducing noise in the repository.
- Expanded README High Level Examples with comprehensive usage examples * Added comments explaining parameters and functions * Added LinearAlgebra import for qr() function * Demonstrated query functions (almostbandwidths, almostbandedrank) * Showed how to access matrix parts (bandpart, fillpart) * Included linear solve and QR factorization examples - Enhanced docstrings with detailed explanations and examples * Added comprehensive docstring for finish_part_setindex! * Improved bandpart() docstring with example * Improved fillpart() docstring explaining low-rank structure * Improved exclusive_bandpart() docstring with example All examples tested and verified to work correctly. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <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
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
This PR improves the documentation quality by expanding examples and enhancing docstrings to help users better understand the package.
Changes Made
README.md:
mfor fill rank,nfor matrix dimension)LinearAlgebraimport to fix the QR factorization examplealmostbandwidths,almostbandedrank)bandpart,fillpart)src/FastAlmostBandedMatrices.jl:
finish_part_setindex!explaining its purpose and usagebandpart()docstring with detailed explanation and working examplefillpart()docstring explaining the low-rank structure and overlapping behaviorexclusive_bandpart()docstring with clear explanation and exampleTesting
All examples have been tested and verified to work correctly:
Review Notes
These changes maintain the author's voice and style while providing clearer guidance for users. No functionality changes were made - only documentation improvements.
cc @ChrisRackauckas
🤖 Generated with Claude Code