Expand documentation a bit more

models/error.go

@@ -8,12 +8,12 @@ import (
 	"fmt"
 )
 
-// ErrNameReserved ...
+// ErrNameReserved represents a "reserved name" error.
 type ErrNameReserved struct {
 	Name string
 }
 
-// IsErrNameReserved ...
+// IsErrNameReserved checks if an error is a ErrNameReserved.
 func IsErrNameReserved(err error) bool {
 	_, ok := err.(ErrNameReserved)
 	return ok
@@ -23,12 +23,13 @@ func (err ErrNameReserved) Error() string {
 	return fmt.Sprintf("name is reserved [name: %s]", err.Name)
 }
 
-// ErrNamePatternNotAllowed ...
+// ErrNamePatternNotAllowed represents a "pattern not allowed" error.
 type ErrNamePatternNotAllowed struct {
 	Pattern string
 }
 
-// IsErrNamePatternNotAllowed ...
+// IsErrNamePatternNotAllowed checks if an error is an
+// ErrNamePatternNotAllowed.
 func IsErrNamePatternNotAllowed(err error) bool {
 	_, ok := err.(ErrNamePatternNotAllowed)
 	return ok
@@ -45,12 +46,12 @@ func (err ErrNamePatternNotAllowed) Error() string {
 // |______//____  >\___  >__|
 //              \/     \/
 
-// ErrUserAlreadyExist ...
+// ErrUserAlreadyExist represents a "user already exists" error.
 type ErrUserAlreadyExist struct {
 	Name string
 }
 
-// IsErrUserAlreadyExist ...
+// IsErrUserAlreadyExist checks if an error is a ErrUserAlreadyExists.
 func IsErrUserAlreadyExist(err error) bool {
 	_, ok := err.(ErrUserAlreadyExist)
 	return ok
@@ -60,14 +61,14 @@ func (err ErrUserAlreadyExist) Error() string {
 	return fmt.Sprintf("user already exists [name: %s]", err.Name)
 }
 
-// ErrUserNotExist ...
+// ErrUserNotExist represents a "UserNotExist" kind of error.
 type ErrUserNotExist struct {
 	UID   int64
 	Name  string
 	KeyID int64
 }
 
-// IsErrUserNotExist ...
+// IsErrUserNotExist checks if an error is a ErrUserNotExist.
 func IsErrUserNotExist(err error) bool {
 	_, ok := err.(ErrUserNotExist)
 	return ok
@@ -77,12 +78,12 @@ func (err ErrUserNotExist) Error() string {
 	return fmt.Sprintf("user does not exist [uid: %d, name: %s, keyid: %d]", err.UID, err.Name, err.KeyID)
 }
 
-// ErrEmailAlreadyUsed ...
+// ErrEmailAlreadyUsed represents a "EmailAlreadyUsed" kind of error.
 type ErrEmailAlreadyUsed struct {
 	Email string
 }
 
-// IsErrEmailAlreadyUsed ...
+// IsErrEmailAlreadyUsed checks if an error is a ErrEmailAlreadyUsed.
 func IsErrEmailAlreadyUsed(err error) bool {
 	_, ok := err.(ErrEmailAlreadyUsed)
 	return ok
@@ -92,12 +93,12 @@ func (err ErrEmailAlreadyUsed) Error() string {
 	return fmt.Sprintf("e-mail has been used [email: %s]", err.Email)
 }
 
-// ErrUserOwnRepos ...
+// ErrUserOwnRepos represents a "UserOwnRepos" kind of error.
 type ErrUserOwnRepos struct {
 	UID int64
 }
 
-// IsErrUserOwnRepos ...
+// IsErrUserOwnRepos checks if an error is a ErrUserOwnRepos.
 func IsErrUserOwnRepos(err error) bool {
 	_, ok := err.(ErrUserOwnRepos)
 	return ok
@@ -107,12 +108,12 @@ func (err ErrUserOwnRepos) Error() string {
 	return fmt.Sprintf("user still has ownership of repositories [uid: %d]", err.UID)
 }
 
-// ErrUserHasOrgs ...
+// ErrUserHasOrgs represents a "UserHasOrgs" kind of error.
 type ErrUserHasOrgs struct {
 	UID int64
 }
 
-// IsErrUserHasOrgs ...
+// IsErrUserHasOrgs checks if an error is a ErrUserHasOrgs.
 func IsErrUserHasOrgs(err error) bool {
 	_, ok := err.(ErrUserHasOrgs)
 	return ok
@@ -122,12 +123,12 @@ func (err ErrUserHasOrgs) Error() string {
 	return fmt.Sprintf("user still has membership of organizations [uid: %d]", err.UID)
 }
 
-// ErrReachLimitOfRepo ...
+// ErrReachLimitOfRepo represents a "ReachLimitOfRepo" kind of error.
 type ErrReachLimitOfRepo struct {
 	Limit int
 }
 
-// IsErrReachLimitOfRepo ...
+// IsErrReachLimitOfRepo checks if an error is a ErrReachLimitOfRepo.
 func IsErrReachLimitOfRepo(err error) bool {
 	_, ok := err.(ErrReachLimitOfRepo)
 	return ok
@@ -144,12 +145,12 @@ func (err ErrReachLimitOfRepo) Error() string {
 //   \__/\  / |__|__|_ \__|
 //        \/          \/
 
-// ErrWikiAlreadyExist ...
+// ErrWikiAlreadyExist represents a "WikiAlreadyExist" kind of error.
 type ErrWikiAlreadyExist struct {
 	Title string
 }
 
-// IsErrWikiAlreadyExist ...
+// IsErrWikiAlreadyExist checks if an error is a ErrWikiAlreadyExist.
 func IsErrWikiAlreadyExist(err error) bool {
 	_, ok := err.(ErrWikiAlreadyExist)
 	return ok
@@ -166,12 +167,12 @@ func (err ErrWikiAlreadyExist) Error() string {
 //  |____|   |____/|___  /____/__|\___  > |____|__ \___  > ____|
 //                     \/             \/          \/   \/\/
 
-// ErrKeyUnableVerify ...
+// ErrKeyUnableVerify represents a "KeyUnableVerify" kind of error.
 type ErrKeyUnableVerify struct {
 	Result string
 }
 
-// IsErrKeyUnableVerify ...
+// IsErrKeyUnableVerify checks if an error is a ErrKeyUnableVerify.
 func IsErrKeyUnableVerify(err error) bool {
 	_, ok := err.(ErrKeyUnableVerify)
 	return ok
@@ -181,12 +182,12 @@ func (err ErrKeyUnableVerify) Error() string {
 	return fmt.Sprintf("Unable to verify key content [result: %s]", err.Result)
 }
 
-// ErrKeyNotExist ...
+// ErrKeyNotExist represents a "KeyNotExist" kind of error.
 type ErrKeyNotExist struct {
 	ID int64
 }
 
-// IsErrKeyNotExist ...
+// IsErrKeyNotExist checks if an error is a ErrKeyNotExist.
 func IsErrKeyNotExist(err error) bool {
 	_, ok := err.(ErrKeyNotExist)
 	return ok
@@ -196,13 +197,13 @@ func (err ErrKeyNotExist) Error() string {
 	return fmt.Sprintf("public key does not exist [id: %d]", err.ID)
 }
 
-// ErrKeyAlreadyExist ...
+// ErrKeyAlreadyExist represents a "KeyAlreadyExist" kind of error.
 type ErrKeyAlreadyExist struct {
 	OwnerID int64
 	Content string
 }
 
-// IsErrKeyAlreadyExist ...
+// IsErrKeyAlreadyExist checks if an error is a ErrKeyAlreadyExist.
 func IsErrKeyAlreadyExist(err error) bool {
 	_, ok := err.(ErrKeyAlreadyExist)
 	return ok
@@ -212,13 +213,13 @@ func (err ErrKeyAlreadyExist) Error() string {
 	return fmt.Sprintf("public key already exists [owner_id: %d, content: %s]", err.OwnerID, err.Content)
 }
 
-// ErrKeyNameAlreadyUsed ...
+// ErrKeyNameAlreadyUsed represents a "KeyNameAlreadyUsed" kind of error.
 type ErrKeyNameAlreadyUsed struct {
 	OwnerID int64
 	Name    string
 }
 
-// IsErrKeyNameAlreadyUsed ...
+// IsErrKeyNameAlreadyUsed checks if an error is a ErrKeyNameAlreadyUsed.
 func IsErrKeyNameAlreadyUsed(err error) bool {
 	_, ok := err.(ErrKeyNameAlreadyUsed)
 	return ok
@@ -228,14 +229,14 @@ func (err ErrKeyNameAlreadyUsed) Error() string {
 	return fmt.Sprintf("public key already exists [owner_id: %d, name: %s]", err.OwnerID, err.Name)
 }
 
-// ErrKeyAccessDenied ...
+// ErrKeyAccessDenied represents a "KeyAccessDenied" kind of error.
 type ErrKeyAccessDenied struct {
 	UserID int64
 	KeyID  int64
 	Note   string
 }
 
-// IsErrKeyAccessDenied ...
+// IsErrKeyAccessDenied checks if an error is a ErrKeyAccessDenied.
 func IsErrKeyAccessDenied(err error) bool {
 	_, ok := err.(ErrKeyAccessDenied)
 	return ok
@@ -246,14 +247,14 @@ func (err ErrKeyAccessDenied) Error() string {
 		err.UserID, err.KeyID, err.Note)
 }
 
-// ErrDeployKeyNotExist ...
+// ErrDeployKeyNotExist represents a "DeployKeyNotExist" kind of error.
 type ErrDeployKeyNotExist struct {
 	ID     int64
 	KeyID  int64
 	RepoID int64
 }
 
-// IsErrDeployKeyNotExist ...
+// IsErrDeployKeyNotExist checks if an error is a ErrDeployKeyNotExist.
 func IsErrDeployKeyNotExist(err error) bool {
 	_, ok := err.(ErrDeployKeyNotExist)
 	return ok
@@ -263,13 +264,13 @@ func (err ErrDeployKeyNotExist) Error() string {
 	return fmt.Sprintf("Deploy key does not exist [id: %d, key_id: %d, repo_id: %d]", err.ID, err.KeyID, err.RepoID)
 }
 
-// ErrDeployKeyAlreadyExist ...
+// ErrDeployKeyAlreadyExist represents a "DeployKeyAlreadyExist" kind of error.
 type ErrDeployKeyAlreadyExist struct {
 	KeyID  int64
 	RepoID int64
 }
 
-// IsErrDeployKeyAlreadyExist ...
+// IsErrDeployKeyAlreadyExist checks if an error is a ErrDeployKeyAlreadyExist.
 func IsErrDeployKeyAlreadyExist(err error) bool {
 	_, ok := err.(ErrDeployKeyAlreadyExist)
 	return ok
@@ -279,13 +280,13 @@ func (err ErrDeployKeyAlreadyExist) Error() string {
 	return fmt.Sprintf("public key already exists [key_id: %d, repo_id: %d]", err.KeyID, err.RepoID)
 }
 
-// ErrDeployKeyNameAlreadyUsed ...
+// ErrDeployKeyNameAlreadyUsed represents a "DeployKeyNameAlreadyUsed" kind of error.
 type ErrDeployKeyNameAlreadyUsed struct {
 	RepoID int64
 	Name   string
 }
 
-// IsErrDeployKeyNameAlreadyUsed ...
+// IsErrDeployKeyNameAlreadyUsed checks if an error is a ErrDeployKeyNameAlreadyUsed.
 func IsErrDeployKeyNameAlreadyUsed(err error) bool {
 	_, ok := err.(ErrDeployKeyNameAlreadyUsed)
 	return ok
@@ -302,12 +303,12 @@ func (err ErrDeployKeyNameAlreadyUsed) Error() string {
 // \____|__  /\___  >___  >___  >____  >____  > |____| \____/|__|_ \\___  >___|  /
 //         \/     \/    \/    \/     \/     \/                    \/    \/     \/
 
-// ErrAccessTokenNotExist ...
+// ErrAccessTokenNotExist represents a "AccessTokenNotExist" kind of error.
 type ErrAccessTokenNotExist struct {
 	SHA string
 }
 
-// IsErrAccessTokenNotExist ...
+// IsErrAccessTokenNotExist checks if an error is a ErrAccessTokenNotExist.
 func IsErrAccessTokenNotExist(err error) bool {
 	_, ok := err.(ErrAccessTokenNotExist)
 	return ok
@@ -317,11 +318,11 @@ func (err ErrAccessTokenNotExist) Error() string {
 	return fmt.Sprintf("access token does not exist [sha: %s]", err.SHA)
 }
 
-// ErrAccessTokenEmpty ...
+// ErrAccessTokenEmpty represents a "AccessTokenEmpty" kind of error.
 type ErrAccessTokenEmpty struct {
 }
 
-// IsErrAccessTokenEmpty ...
+// IsErrAccessTokenEmpty checks if an error is a ErrAccessTokenEmpty.
 func IsErrAccessTokenEmpty(err error) bool {
 	_, ok := err.(ErrAccessTokenEmpty)
 	return ok
@@ -338,12 +339,12 @@ func (err ErrAccessTokenEmpty) Error() string {
 // \_______  /__|  \___  (____  /___|  /__/_____ \(____  /__| |__|\____/|___|  /
 //         \/     /_____/     \/     \/         \/     \/                    \/
 
-// ErrLastOrgOwner ...
+// ErrLastOrgOwner represents a "LastOrgOwner" kind of error.
 type ErrLastOrgOwner struct {
 	UID int64
 }
 
-// IsErrLastOrgOwner ...
+// IsErrLastOrgOwner checks if an error is a ErrLastOrgOwner.
 func IsErrLastOrgOwner(err error) bool {
 	_, ok := err.(ErrLastOrgOwner)
 	return ok
@@ -360,14 +361,14 @@ func (err ErrLastOrgOwner) Error() string {
 //  |____|_  /\___  >   __/ \____/____  >__||__|  \____/|__|   / ____|
 //         \/     \/|__|              \/                       \/
 
-// ErrRepoNotExist ...
+// ErrRepoNotExist represents a "RepoNotExist" kind of error.
 type ErrRepoNotExist struct {
 	ID   int64
 	UID  int64
 	Name string
 }
 
-// IsErrRepoNotExist ...
+// IsErrRepoNotExist checks if an error is a ErrRepoNotExist.
 func IsErrRepoNotExist(err error) bool {
 	_, ok := err.(ErrRepoNotExist)
 	return ok
@@ -377,13 +378,13 @@ func (err ErrRepoNotExist) Error() string {
 	return fmt.Sprintf("repository does not exist [id: %d, uid: %d, name: %s]", err.ID, err.UID, err.Name)
 }
 
-// ErrRepoAlreadyExist ...
+// ErrRepoAlreadyExist represents a "RepoAlreadyExist" kind of error.
 type ErrRepoAlreadyExist struct {
 	Uname string
 	Name  string
 }
 
-// IsErrRepoAlreadyExist ...
+// IsErrRepoAlreadyExist checks if an error is a ErrRepoAlreadyExist.
 func IsErrRepoAlreadyExist(err error) bool {
 	_, ok := err.(ErrRepoAlreadyExist)
 	return ok
@@ -393,14 +394,14 @@ func (err ErrRepoAlreadyExist) Error() string {
 	return fmt.Sprintf("repository already exists [uname: %s, name: %s]", err.Uname, err.Name)
 }
 
-// ErrInvalidCloneAddr ...
+// ErrInvalidCloneAddr represents a "InvalidCloneAddr" kind of error.
 type ErrInvalidCloneAddr struct {
 	IsURLError         bool
 	IsInvalidPath      bool
 	IsPermissionDenied bool
 }
 
-// IsErrInvalidCloneAddr ...
+// IsErrInvalidCloneAddr checks if an error is a ErrInvalidCloneAddr.
 func IsErrInvalidCloneAddr(err error) bool {
 	_, ok := err.(ErrInvalidCloneAddr)
 	return ok
@@ -411,12 +412,12 @@ func (err ErrInvalidCloneAddr) Error() string {
 		err.IsURLError, err.IsInvalidPath, err.IsPermissionDenied)
 }
 
-// ErrUpdateTaskNotExist ...
+// ErrUpdateTaskNotExist represents a "UpdateTaskNotExist" kind of error.
 type ErrUpdateTaskNotExist struct {
 	UUID string
 }
 
-// IsErrUpdateTaskNotExist ...
+// IsErrUpdateTaskNotExist checks if an error is a ErrUpdateTaskNotExist.
 func IsErrUpdateTaskNotExist(err error) bool {
 	_, ok := err.(ErrUpdateTaskNotExist)
 	return ok
@@ -426,12 +427,12 @@ func (err ErrUpdateTaskNotExist) Error() string {
 	return fmt.Sprintf("update task does not exist [uuid: %s]", err.UUID)
 }
 
-// ErrReleaseAlreadyExist ...
+// ErrReleaseAlreadyExist represents a "ReleaseAlreadyExist" kind of error.
 type ErrReleaseAlreadyExist struct {
 	TagName string
 }
 
-// IsErrReleaseAlreadyExist ...
+// IsErrReleaseAlreadyExist checks if an error is a ErrReleaseAlreadyExist.
 func IsErrReleaseAlreadyExist(err error) bool {
 	_, ok := err.(ErrReleaseAlreadyExist)
 	return ok
@@ -441,13 +442,13 @@ func (err ErrReleaseAlreadyExist) Error() string {
 	return fmt.Sprintf("release tag already exist [tag_name: %s]", err.TagName)
 }
 
-// ErrReleaseNotExist ...
+// ErrReleaseNotExist represents a "ReleaseNotExist" kind of error.
 type ErrReleaseNotExist struct {
 	ID      int64
 	TagName string
 }
 
-// IsErrReleaseNotExist ...
+// IsErrReleaseNotExist checks if an error is a ErrReleaseNotExist.
 func IsErrReleaseNotExist(err error) bool {
 	_, ok := err.(ErrReleaseNotExist)
 	return ok
@@ -457,12 +458,12 @@ func (err ErrReleaseNotExist) Error() string {
 	return fmt.Sprintf("release tag does not exist [id: %d, tag_name: %s]", err.ID, err.TagName)
 }
 
-// ErrInvalidTagName ...
+// ErrInvalidTagName represents a "InvalidTagName" kind of error.
 type ErrInvalidTagName struct {
 	TagName string
 }
 
-// IsErrInvalidTagName ...
+// IsErrInvalidTagName checks if an error is a ErrInvalidTagName.
 func IsErrInvalidTagName(err error) bool {
 	_, ok := err.(ErrInvalidTagName)
 	return ok
@@ -472,12 +473,12 @@ func (err ErrInvalidTagName) Error() string {
 	return fmt.Sprintf("release tag name is not valid [tag_name: %s]", err.TagName)
 }
 
-// ErrRepoFileAlreadyExist ...
+// ErrRepoFileAlreadyExist represents a "RepoFileAlreadyExist" kind of error.
 type ErrRepoFileAlreadyExist struct {
 	FileName string
 }
 
-// IsErrRepoFileAlreadyExist ...
+// IsErrRepoFileAlreadyExist checks if an error is a ErrRepoFileAlreadyExist.
 func IsErrRepoFileAlreadyExist(err error) bool {
 	_, ok := err.(ErrRepoFileAlreadyExist)
 	return ok
@@ -494,12 +495,12 @@ func (err ErrRepoFileAlreadyExist) Error() string {
 //  |______  / |__|  (____  /___|  /\___  >___|  /
 //         \/             \/     \/     \/     \/
 
-// ErrBranchNotExist ...
+// ErrBranchNotExist represents a "BranchNotExist" kind of error.
 type ErrBranchNotExist struct {
 	Name string
 }
 
-// IsErrBranchNotExist ...
+// IsErrBranchNotExist checks if an error is a ErrBranchNotExist.
 func IsErrBranchNotExist(err error) bool {
 	_, ok := err.(ErrBranchNotExist)
 	return ok
@@ -516,12 +517,12 @@ func (err ErrBranchNotExist) Error() string {
 //   \__/\  /  \___  >___  /___|  /\____/ \____/|__|_ \
 //        \/       \/    \/     \/                   \/
 
-// ErrWebhookNotExist ...
+// ErrWebhookNotExist represents a "WebhookNotExist" kind of error.
 type ErrWebhookNotExist struct {
 	ID int64
 }
 
-// IsErrWebhookNotExist ...
+// IsErrWebhookNotExist checks if an error is a ErrWebhookNotExist.
 func IsErrWebhookNotExist(err error) bool {
 	_, ok := err.(ErrWebhookNotExist)
 	return ok
@@ -538,14 +539,14 @@ func (err ErrWebhookNotExist) Error() string {
 // |___/____  >____  >____/  \___  >
 //          \/     \/            \/
 
-// ErrIssueNotExist ...
+// ErrIssueNotExist represents a "IssueNotExist" kind of error.
 type ErrIssueNotExist struct {
 	ID     int64
 	RepoID int64
 	Index  int64
 }
 
-// IsErrIssueNotExist ...
+// IsErrIssueNotExist checks if an error is a ErrIssueNotExist.
 func IsErrIssueNotExist(err error) bool {
 	_, ok := err.(ErrIssueNotExist)
 	return ok
@@ -562,7 +563,7 @@ func (err ErrIssueNotExist) Error() string {
 //  |____|   |____/|____/____/____|_  /\___  >__   |____/  \___  >____  > |__|
 //                                  \/     \/   |__|           \/     \/
 
-// ErrPullRequestNotExist ...
+// ErrPullRequestNotExist represents a "PullRequestNotExist" kind of error.
 type ErrPullRequestNotExist struct {
 	ID         int64
 	IssueID    int64
@@ -572,7 +573,7 @@ type ErrPullRequestNotExist struct {
 	BaseBranch string
 }
 
-// IsErrPullRequestNotExist ...
+// IsErrPullRequestNotExist checks if an error is a ErrPullRequestNotExist.
 func IsErrPullRequestNotExist(err error) bool {
 	_, ok := err.(ErrPullRequestNotExist)
 	return ok
@@ -590,13 +591,13 @@ func (err ErrPullRequestNotExist) Error() string {
 //  \______  /\____/|__|_|  /__|_|  /\___  >___|  /__|
 //         \/             \/      \/     \/     \/
 
-// ErrCommentNotExist ...
+// ErrCommentNotExist represents a "CommentNotExist" kind of error.
 type ErrCommentNotExist struct {
 	ID      int64
 	IssueID int64
 }
 
-// IsErrCommentNotExist ...
+// IsErrCommentNotExist checks if an error is a ErrCommentNotExist.
 func IsErrCommentNotExist(err error) bool {
 	_, ok := err.(ErrCommentNotExist)
 	return ok
@@ -613,13 +614,13 @@ func (err ErrCommentNotExist) Error() string {
 // |_______ (____  /___  /\___  >____/
 //         \/    \/    \/     \/
 
-// ErrLabelNotExist ...
+// ErrLabelNotExist represents a "LabelNotExist" kind of error.
 type ErrLabelNotExist struct {
 	LabelID int64
 	RepoID  int64
 }
 
-// IsErrLabelNotExist ...
+// IsErrLabelNotExist checks if an error is a ErrLabelNotExist.
 func IsErrLabelNotExist(err error) bool {
 	_, ok := err.(ErrLabelNotExist)
 	return ok
@@ -636,13 +637,13 @@ func (err ErrLabelNotExist) Error() string {
 // \____|__  /__|____/\___  >____  > |__|  \____/|___|  /\___  >
 //         \/             \/     \/                   \/     \/
 
-// ErrMilestoneNotExist ...
+// ErrMilestoneNotExist represents a "MilestoneNotExist" kind of error.
 type ErrMilestoneNotExist struct {
 	ID     int64
 	RepoID int64
 }
 
-// IsErrMilestoneNotExist ...
+// IsErrMilestoneNotExist checks if an error is a ErrMilestoneNotExist.
 func IsErrMilestoneNotExist(err error) bool {
 	_, ok := err.(ErrMilestoneNotExist)
 	return ok
@@ -659,13 +660,13 @@ func (err ErrMilestoneNotExist) Error() string {
 // \____|__  /__|  |__| (____  /\___  >___|  /__|_|  /\___  >___|  /__|
 //         \/                \/     \/     \/      \/     \/     \/
 
-// ErrAttachmentNotExist ...
+// ErrAttachmentNotExist represents a "AttachmentNotExist" kind of error.
 type ErrAttachmentNotExist struct {
 	ID   int64
 	UUID string
 }
 
-// IsErrAttachmentNotExist ...
+// IsErrAttachmentNotExist checks if an error is a ErrAttachmentNotExist.
 func IsErrAttachmentNotExist(err error) bool {
 	_, ok := err.(ErrAttachmentNotExist)
 	return ok
@@ -682,12 +683,12 @@ func (err ErrAttachmentNotExist) Error() string {
 // |_______ \____/\___  /|__|___|  / /_______  /\____/|____/ |__|    \___  >___  >
 //         \/    /_____/         \/          \/                          \/    \/
 
-// ErrLoginSourceNotExist ...
+// ErrLoginSourceNotExist represents a "LoginSourceNotExist" kind of error.
 type ErrLoginSourceNotExist struct {
 	ID int64
 }
 
-// IsErrLoginSourceNotExist ...
+// IsErrLoginSourceNotExist checks if an error is a ErrLoginSourceNotExist.
 func IsErrLoginSourceNotExist(err error) bool {
 	_, ok := err.(ErrLoginSourceNotExist)
 	return ok
@@ -697,12 +698,12 @@ func (err ErrLoginSourceNotExist) Error() string {
 	return fmt.Sprintf("login source does not exist [id: %d]", err.ID)
 }
 
-// ErrLoginSourceAlreadyExist ...
+// ErrLoginSourceAlreadyExist represents a "LoginSourceAlreadyExist" kind of error.
 type ErrLoginSourceAlreadyExist struct {
 	Name string
 }
 
-// IsErrLoginSourceAlreadyExist ...
+// IsErrLoginSourceAlreadyExist checks if an error is a ErrLoginSourceAlreadyExist.
 func IsErrLoginSourceAlreadyExist(err error) bool {
 	_, ok := err.(ErrLoginSourceAlreadyExist)
 	return ok
@@ -712,12 +713,12 @@ func (err ErrLoginSourceAlreadyExist) Error() string {
 	return fmt.Sprintf("login source already exists [name: %s]", err.Name)
 }
 
-// ErrLoginSourceInUse ...
+// ErrLoginSourceInUse represents a "LoginSourceInUse" kind of error.
 type ErrLoginSourceInUse struct {
 	ID int64
 }
 
-// IsErrLoginSourceInUse ...
+// IsErrLoginSourceInUse checks if an error is a ErrLoginSourceInUse.
 func IsErrLoginSourceInUse(err error) bool {
 	_, ok := err.(ErrLoginSourceInUse)
 	return ok
@@ -734,13 +735,13 @@ func (err ErrLoginSourceInUse) Error() string {
 //   |____| \___  >____  /__|_|  /
 //              \/     \/      \/
 
-// ErrTeamAlreadyExist ...
+// ErrTeamAlreadyExist represents a "TeamAlreadyExist" kind of error.
 type ErrTeamAlreadyExist struct {
 	OrgID int64
 	Name  string
 }
 
-// IsErrTeamAlreadyExist ...
+// IsErrTeamAlreadyExist checks if an error is a ErrTeamAlreadyExist.
 func IsErrTeamAlreadyExist(err error) bool {
 	_, ok := err.(ErrTeamAlreadyExist)
 	return ok
@@ -758,13 +759,13 @@ func (err ErrTeamAlreadyExist) Error() string {
 //           |__|                   \/      \/
 //
 
-// ErrUploadNotExist ...
+// ErrUploadNotExist represents a "UploadNotExist" kind of error.
 type ErrUploadNotExist struct {
 	ID   int64
 	UUID string
 }
 
-// IsErrUploadNotExist ...
+// IsErrUploadNotExist checks if an error is a ErrUploadNotExist.
 func IsErrUploadNotExist(err error) bool {
 	_, ok := err.(ErrAttachmentNotExist)
 	return ok