Add comprehensive docstrings for cache functions #136
Merged
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
- Added detailed docstring for get_tmp explaining dual number handling - Added docstring for enlargediffcache! explaining resizing behavior - Improved documentation for automatic differentiation support
- Created internals.md documenting internal functions - Added internal functions to documentation navigation - Documented get_tmp overloads and enlargediffcache! - Added warning that these are internal implementation details
|
I've added an internals documentation section as requested:
This keeps the main API documentation clean while still providing documentation for users who might encounter these functions during debugging or when the enlargement warning appears. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
Changes
get_tmp(::FixedSizeDiffCache, ...)explaining:enlargediffcache!explaining:Test Plan
This PR improves the documentation consistency in PreallocationTools.jl by ensuring internal functions that users might encounter (via warnings or when debugging) have proper documentation.