Improve the comment for go_sdk.host() in the installation docs#4230
Merged
fmeum merged 1 commit intobazel-contrib:masterfrom Jan 15, 2025
Merged
Conversation
fmeum
approved these changes
Jan 15, 2025
1 task
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.
What type of PR is this?
Documentation
What does this PR do?
Explicitly call out
go_sdk.host()as an alternative togo_sdk.download()in the Bzlmod installation documentation, and point clearly to the nota bene associated with it.What does this PR do? Why is it needed?
Avoiding people from copying and pasting the code without understanding that
go_sdk.host()should be omitted when usinggo_sdk.download()(as well as making sure that there's a clear pointer to its drawbacks).Which issues(s) does this PR fix?
N/A