Skip to content

docs: fix spacing and grammar in doc comments #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aoright wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −4
Open

docs: fix spacing and grammar in doc comments #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

// Package uuid generates and inspects UUIDs.
//
// UUIDs are based on RFC 9562(obsoletes RFC 4122) and DCE 1.1: Authentication and Security
// UUIDs are based on RFC 9562 (obsoletes RFC 4122) and DCE 1.1: Authentication and Security
// Services.
//
// A UUID is a 16 byte (128 bit) array. UUIDs may be used as keys to
Expand Down
6 changes: 3 additions & 3 deletions uuid.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ type Variant byte
// Constants returned by Variant.
const (
Invalid = Variant(iota) // Invalid UUID
RFC4122 // The variant specified in RFC9562(obsoletes RFC4122).
RFC4122 // The variant specified in RFC 9562 (obsoletes RFC 4122).
Reserved // Reserved, NCS backward compatibility.
Microsoft // Reserved, Microsoft Corporation backward compatibility.
Future // Reserved for future definition.
)

// RFC9562 added V6 and V7 of UUID, but did not change specification of V1 and V4
// RFC 9562 added V6 and V7 of UUID, but did not change the specification of V1 and V4
// implemented in this module. To avoid creating new major module version,
// we still use RFC4122 for constant name.
const Standard = RFC4122
Expand Down Expand Up @@ -78,7 +78,7 @@ func (e invalidLengthError) Is(target error) bool {

var ErrInvalidLength = invalidLengthError{}

// IsInvalidLengthError is matcher function for custom error invalidLengthError
// IsInvalidLengthError is a matcher function for custom error invalidLengthError.
func IsInvalidLengthError(err error) bool {
return errors.Is(err, ErrInvalidLength)
}
Expand Down