user: fix swapped file references in error godoc#233
Open
sueun-dev wants to merge 1 commit into
Open
Conversation
ErrNoPasswdEntries and ErrNoGroupEntries had their doc comments swapped:
ErrNoPasswdEntries ("no matching entries in passwd file", returned from
LookupUser/LookupUid and GetExecUser's user lookup) was documented as
/etc/group, and ErrNoGroupEntries ("no matching entries in group file",
returned from LookupGroup/LookupGid and GetExecUser's group lookup) was
documented as /etc/passwd. The variable name, error message, and every
usage agree; only the comment was wrong. Swap the two references so each
comment matches its variable.
Signed-off-by: Sueun Cho <sueun.dev@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 doc comments on ErrNoPasswdEntries and ErrNoGroupEntries are swapped. ErrNoPasswdEntries ("no matching entries in passwd file", returned from LookupUser/LookupUid and GetExecUser's user lookup) is documented as /etc/group, and ErrNoGroupEntries ("no matching entries in group file", returned from LookupGroup/LookupGid and GetExecUser's group lookup) is documented as /etc/passwd. Each comment names the other file.
The variable name, error message, and every usage agree; only the comment is wrong, and since these are exported errors the incorrect text shows up in godoc. This swaps the two references so each comment matches its variable.