Improve documentation of OverrideSync#4849
Merged
WeiqunZhang merged 4 commits intoAMReX-Codes:developmentfrom Dec 15, 2025
Merged
Improve documentation of OverrideSync#4849WeiqunZhang merged 4 commits intoAMReX-Codes:developmentfrom
WeiqunZhang merged 4 commits intoAMReX-Codes:developmentfrom
Conversation
EZoni
commented
Dec 12, 2025
WeiqunZhang
reviewed
Dec 14, 2025
EZoni
commented
Dec 15, 2025
Co-authored-by: Edoardo Zoni <[email protected]>
WeiqunZhang
approved these changes
Dec 15, 2025
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
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 improves the documentation of
OverrideSync, based on an exchange between @WeiqunZhang, @aeriforme, and myself in BLAST-WarpX/warpx#6438:FabArray::OverrideSyncin Src/Base/AMReX_FabArray.H.FabArray::OverrideSyncover to docstring ofMultiFab::OverrideSyncin Src/Base/AMReX_MultiFab.H for consistency.Checklist
The proposed changes: