From 6213f2f6a55eac3741f96cc3536e9ffa133d87dc Mon Sep 17 00:00:00 2001 From: MarvinJWendt Date: Wed, 26 Jun 2024 07:48:02 +0000 Subject: [PATCH] docs: autoupdate --- README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0dcf690..bc6970b 100644 --- a/README.md +++ b/README.md @@ -85,25 +85,26 @@ repo.CreateErrorReport(err) // Only creates an error report if the error is not ## Index - [Variables](<#variables>) -- [type Issue](<#type-issue>) - - [func NewIssue(repo Repository, title, body string) Issue](<#func-newissue>) - - [func (issue Issue) GetCreateURL() string](<#func-issue-getcreateurl>) - - [func (issue Issue) Open() error](<#func-issue-open>) -- [type Repository](<#type-repository>) - - [func NewRepository(owner, name string) Repository](<#func-newrepository>) - - [func (repo Repository) CreateErrorReport(err error) error](<#func-repository-createerrorreport>) - - [func (repo Repository) NewIssue(title, body string) Issue](<#func-repository-newissue>) - - [func (repo Repository) String() string](<#func-repository-string>) +- [type Issue](<#Issue>) + - [func NewIssue\(repo Repository, title, body string\) Issue](<#NewIssue>) + - [func \(issue Issue\) GetCreateURL\(\) string](<#Issue.GetCreateURL>) + - [func \(issue Issue\) Open\(\) error](<#Issue.Open>) +- [type Repository](<#Repository>) + - [func NewRepository\(owner, name string\) Repository](<#NewRepository>) + - [func \(repo Repository\) CreateErrorReport\(err error\) error](<#Repository.CreateErrorReport>) + - [func \(repo Repository\) NewIssue\(title, body string\) Issue](<#Repository.NewIssue>) + - [func \(repo Repository\) String\(\) string](<#Repository.String>) ## Variables -ErrOpenBrowser is the error returned when opening the browser fails. +ErrOpenBrowser is the error returned when opening the browser fails. ```go var ErrOpenBrowser = errors.New("failed to open browser") ``` + ## type [Issue]() Issue is a GitHub issue. @@ -116,6 +117,7 @@ type Issue struct { } ``` + ### func [NewIssue]() ```go @@ -124,6 +126,7 @@ func NewIssue(repo Repository, title, body string) Issue NewIssue creates a new issue. + ### func \(Issue\) [GetCreateURL]() ```go @@ -132,6 +135,7 @@ func (issue Issue) GetCreateURL() string GetCreateURL returns the URL to create an issue. + ### func \(Issue\) [Open]() ```go @@ -140,6 +144,7 @@ func (issue Issue) Open() error Open opens the "create issue" menu on GitHub in the browser. + ## type [Repository]() Repository is a GitHub repository. @@ -151,6 +156,7 @@ type Repository struct { } ``` + ### func [NewRepository]() ```go @@ -159,6 +165,7 @@ func NewRepository(owner, name string) Repository NewRepository creates a new Repository from an owner and repository name. + ### func \(Repository\) [CreateErrorReport]() ```go @@ -176,6 +183,7 @@ repo := ghissue.NewRepository("atomicgo", "ghissue") repo.CreateErrorReport(err) ``` + ### func \(Repository\) [NewIssue]() ```go @@ -184,6 +192,7 @@ func (repo Repository) NewIssue(title, body string) Issue NewIssue creates a new issue with a title and body. + ### func \(Repository\) [String]() ```go @@ -192,8 +201,6 @@ func (repo Repository) String() string String returns the string representation of the repository. - - Generated by [gomarkdoc]()