Use robots to update doc comments#652
Merged
Merged
Conversation
jonwis
approved these changes
Jul 17, 2026
jonwis
left a comment
jonwis
left a comment
Member
There was a problem hiding this comment.
Seems ok; it'd be interesting to get the bot to update the wiki repo as well. Not sure how often people read that vs the header, but it's useful stuff.
Member
Author
Yes, the wiki is on the list of things to investigate. This just seemed simpler and easier to do/validate right now. Personally, I don't care much about doxygen, however many editors use the doxygen comments when showing previews/autocomplete, so it's at least useful for that. |
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
2 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.
Ensuring doc comments (1) exist, (2) are accurate, and (3) are kept up to date has not been a strong suit of ours... I'm going to start going through and let the robots clean things up. Plan is to issue one PR per header file so that the changes are not overwhelming.
Long term - would be nice to have GHCP do this on PRs, issuing change suggestions as necessary.