From dd95e2dbfad7f39060dc70f145d0e1478770e454 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Tue, 18 Feb 2025 10:23:44 +0800 Subject: *.go: Add some comments for docs --- database.go | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'database.go') diff --git a/database.go b/database.go index 48d745b..e2591d2 100644 --- a/database.go +++ b/database.go @@ -4,6 +4,8 @@ import ( "context" ) +// query_list is a helper function that executes a query and returns a list of +// results. func query_list[T any](ctx context.Context, query string, args ...any) ([]T, error) { rows, err := database.Query(ctx, query, args...) if err != nil { @@ -27,6 +29,8 @@ func query_list[T any](ctx context.Context, query string, args ...any) ([]T, err return result, nil } +// query_name_desc_list is a helper function that executes a query and returns a +// list of name_desc_t results. func query_name_desc_list(ctx context.Context, query string, args ...any) ([]name_desc_t, error) { rows, err := database.Query(ctx, query, args...) if err != nil { @@ -45,6 +49,7 @@ func query_name_desc_list(ctx context.Context, query string, args ...any) ([]nam return result, rows.Err() } +// name_desc_t holds a name and a description. type name_desc_t struct { Name string Description string -- cgit v1.2.3