fix: correct AddBgRGB godoc and tighten both RGB examples#287
Open
c-tonneslan wants to merge 1 commit into
Open
fix: correct AddBgRGB godoc and tighten both RGB examples#287c-tonneslan wants to merge 1 commit into
c-tonneslan wants to merge 1 commit into
Conversation
The AddBgRGB docstring started with "AddRGB", which made it look like a copy of the AddRGB doc. Both examples (.Add(34, 0, 12).Add(255, 128, 0)) also didn't show a realistic call, since the methods take three ints, not a chain of Add(...) calls. Cleaned both up so the names match and the examples actually compile. Signed-off-by: Charlie Tonneslan <cst0520@gmail.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.
The godoc for
AddBgRGBstarts with "AddRGB", which made it look like a copy of theAddRGBdoc. The example in both (`.Add(34, 0, 12).Add(255, 128, 0)`) also doesn't compile as written, sinceAddRGB/AddBgRGBtake three ints, not a chain ofAdd(...)calls.Cleaned both docstrings up so the names match the methods they describe and the examples are actually valid Go.
Test plan
No behavior change, comments only.