Add package doc comments to all builtins#19
Merged
AlexandreYang merged 1 commit intomainfrom Mar 10, 2026
Merged
Conversation
Co-authored-by: AlexandreYang <49917914+AlexandreYang@users.noreply.github.com>
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
1 participant
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.
What does this PR do?
Adds package-level doc comments describing each builtin command to all builtin
.gofiles, matching the style already used inhead.go.Motivation
head.goalready has a comprehensive package doc comment describing the command's purpose, usage, flags, and exit codes. The remaining builtins (cat, echo, break, continue, exit, false, true) were missing these descriptions.Testing
go build ./interp/builtins/...passes.Checklist
PR by Bits
View session in Datadog
Comment @DataDog to request changes