Fix linting issues caused by lack of godoc comments #100
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
KendallWeihe
requested review from
alecthomas,
mihai-chiorean,
mistermoe,
tomdaffurn and
wesbillman
as code owners
KendallWeihe
changed the title
mistermoe
approved these changes
Mar 5, 2024
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.
Linting on main is currently failing because of a lot of lacking godoc comments for exported members. This PR adds the comments. In full transparency, I think the doc comments here are insufficient, in that a lot of comments need additional language added. I was hoping we could get the pipeline back to functional, so that linting is actually useful for current code changes, and then follow-up with this ticket to add additional context and whatnot.
This work spurred the creation of this ticket #98