Fix cartesian_product dox #4700
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
kidder
requested changes
Feb 7, 2023
src/Utilities/CartesianProduct.hpp
Outdated
| * \brief The Cartesian product of a sequence arrays | ||
| * | ||
| * Returns a `std::array` with all possible combinations of the input arrays. | ||
| * The last dimension varies fastest. | ||
| * | ||
| * \example | ||
| * \snippet Test_CartesianProduct.cpp cartesian_product |
There was a problem hiding this comment.
I think a better (or additional example) is how it is used in Test_Wedge3D
Functions without a namespace don't show up in the dox by default.
|
changed the example, and pushed a commit propagating the function to a few more domain creator tests |
kidder
previously approved these changes
Feb 7, 2023
|
@nilsvu this isn't compiling... |
kidder
approved these changes
Feb 7, 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.
Functions without a namespace don't show up in the dox by default.
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