From 77a6bd1dd712ae3ec3de01fed9e8940f3c04f681 Mon Sep 17 00:00:00 2001 From: kim Date: Fri, 24 Jan 2025 13:30:04 +0000 Subject: [PATCH] improve code comments --- internal/db/application.go | 26 +++++++++++++------------- internal/gtsmodel/token.go | 3 ++- internal/webpush/realsender.go | 3 ++- 3 files changed, 17 insertions(+), 15 deletions(-) diff --git a/internal/db/application.go b/internal/db/application.go index 5a4068431..1011698bf 100644 --- a/internal/db/application.go +++ b/internal/db/application.go @@ -36,42 +36,42 @@ type Application interface { // DeleteApplicationByClientID deletes the application with corresponding client_id value from the database. DeleteApplicationByClientID(ctx context.Context, clientID string) error - // GetClientByID ... + // GetClientByID fetches the application client from database with ID. GetClientByID(ctx context.Context, id string) (*gtsmodel.Client, error) - // PutClient ... + // PutClient puts the given application client in the database. PutClient(ctx context.Context, client *gtsmodel.Client) error - // DeleteClientByID ... + // DeleteClientByID deletes the application client from database with ID. DeleteClientByID(ctx context.Context, id string) error - // GetAllTokens ... + // GetAllTokens fetches all client oauth tokens from database. GetAllTokens(ctx context.Context) ([]*gtsmodel.Token, error) - // GetTokenByID ... + // GetTokenByID fetches the client oauth token from database with ID. GetTokenByID(ctx context.Context, id string) (*gtsmodel.Token, error) - // GetTokenByCode ... + // GetTokenByCode fetches the client oauth token from database with code. GetTokenByCode(ctx context.Context, code string) (*gtsmodel.Token, error) - // GetTokenByAccess ... + // GetTokenByAccess fetches the client oauth token from database with access code. GetTokenByAccess(ctx context.Context, access string) (*gtsmodel.Token, error) - // GetTokenByRefresh ... + // GetTokenByRefresh fetches the client oauth token from database with refresh code. GetTokenByRefresh(ctx context.Context, refresh string) (*gtsmodel.Token, error) - // PutToken ... + // PutToken puts given client oauth token in the database. PutToken(ctx context.Context, token *gtsmodel.Token) error - // DeleteTokenByID ... + // DeleteTokenByID deletes client oauth token from database with ID. DeleteTokenByID(ctx context.Context, id string) error - // DeleteTokenByCode ... + // DeleteTokenByCode deletes client oauth token from database with code. DeleteTokenByCode(ctx context.Context, code string) error - // DeleteTokenByAccess ... + // DeleteTokenByAccess deletes client oauth token from database with access code. DeleteTokenByAccess(ctx context.Context, access string) error - // DeleteTokenByRefresh ... + // DeleteTokenByRefresh deletes client oauth token from database with refresh code. DeleteTokenByRefresh(ctx context.Context, refresh string) error } diff --git a/internal/gtsmodel/token.go b/internal/gtsmodel/token.go index fd640abde..0586ae68a 100644 --- a/internal/gtsmodel/token.go +++ b/internal/gtsmodel/token.go @@ -19,7 +19,8 @@ import "time" -// Token is a translation of the gotosocial token with the ExpiresIn fields replaced with ExpiresAt. +// Token is a translation of the gotosocial token +// with the ExpiresIn fields replaced with ExpiresAt. type Token struct { ID string `bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database CreatedAt time.Time `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created diff --git a/internal/webpush/realsender.go b/internal/webpush/realsender.go index a19fc8b37..4c4657957 100644 --- a/internal/webpush/realsender.go +++ b/internal/webpush/realsender.go @@ -39,7 +39,8 @@ "github.com/superseriousbusiness/gotosocial/internal/typeutils" ) -// realSender is the production Web Push sender, backed by an HTTP client, DB, and worker pool. +// realSender is the production Web Push sender, +// backed by an HTTP client, DB, and worker pool. type realSender struct { httpClient *http.Client state *state.State