Improve documentation for amr::Criterion #4707
Merged
Conversation
This file contains 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
nilsvu
previously approved these changes
Feb 8, 2023
| /// call operator. | ||
| /// The call operator should take as arguments the values corresponding to each | ||
| /// tag in `argument_tags` (in order), followed by the Parallel::GlobalCache, | ||
| /// and the ArrayIndex (which is typically an ElementId). The tags listed in |
There was a problem hiding this comment.
Can we simplify this and just make this an ElementId, removing the ArrayIndex template parameter? We assume it's an ElementId anyway down the line. Feel free to push as separate commit if you agree.
kidder
force-pushed
the
amr_criterion_docs
branch
from
24dc488
to
39ae07b
Compare
nilsvu
approved these changes
Feb 8, 2023
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.
Proposed changes
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments