docs: rewrite Tags.Get doc comment#28
Open
c-tonneslan wants to merge 1 commit into
Open
Conversation
The current comment describes a returned 'ok' value that doesn't exist (the function returns *Tag and error), and the wording about the value 'being the empty string' doesn't match how Tag is structured either. Cleaned-up phrasing that actually matches the signature and the only error it can return. For fatih#26 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.
For #26.
The current Get comment talks about an `ok` return value that doesn't exist (the function returns `(*Tag, error)`) and mentions returning an 'empty string' which doesn't match how Tag is structured. Updated to actually describe the signature and the only error returned.
This is intentionally separate from the export-sentinels PR (#27) so each can land on its own. Once #27 lands the doc can be tightened further to mention `errors.Is(err, structtag.ErrTagNotExist)`.