Add pre-commit hook to validate doxygen #1334
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
vyasr
added
3 - Ready for review
bdice
reviewed
Sep 6, 2023
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
I'd like to do that in a separate PR since it'll require also fixing a new set of additional errors and I want the automated checking in place beforehand. Also I'd like to synchronize that update with a corresponding cudf PR. |
bdice
approved these changes
Sep 6, 2023
|
/merge |
harrism
approved these changes
Sep 6, 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.
Description
This change ensures that our doxygen documentation stays up to date during development. Since pre-commit also runs during CI, C++ documentation will be validated on every pull request.
Checklist