From f8224ed05dfed53835bd4d4ef8cc289386c43ba0 Mon Sep 17 00:00:00 2001 From: Virgil Date: Thu, 2 Apr 2026 07:22:52 +0000 Subject: [PATCH] docs(forge): improve top-level usage examples Co-Authored-By: Virgil --- forge.go | 6 ++++-- pagination.go | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/forge.go b/forge.go index 22ff0f2..1407325 100644 --- a/forge.go +++ b/forge.go @@ -4,8 +4,9 @@ package forge // // Usage: // +// ctx := context.Background() // f := forge.NewForge("https://forge.lthn.ai", "token") -// _ = f.Repos +// repo, err := f.Repos.Get(ctx, forge.Params{"owner": "core", "repo": "go-forge"}) type Forge struct { client *Client @@ -35,8 +36,9 @@ type Forge struct { // // Usage: // +// ctx := context.Background() // f := forge.NewForge("https://forge.lthn.ai", "token") -// _ = f +// repos, err := f.Repos.ListOrgRepos(ctx, "core") func NewForge(url, token string, opts ...Option) *Forge { c := NewClient(url, token, opts...) f := &Forge{client: c} diff --git a/pagination.go b/pagination.go index 40bf4f0..d375633 100644 --- a/pagination.go +++ b/pagination.go @@ -23,7 +23,7 @@ type ListOptions struct { Limit int // items per page (default 50) } -// DefaultList returns sensible default pagination. +// DefaultList provides sensible default pagination. // // Usage: //