Skip to content

Commit

Permalink
docs: autoupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Jun 26, 2024
1 parent b84dd37 commit 6213f2f
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<a name="ErrOpenBrowser"></a>ErrOpenBrowser is the error returned when opening the browser fails.

```go
var ErrOpenBrowser = errors.New("failed to open browser")
```

<a name="Issue"></a>
## type [Issue](<https://github.com/atomicgo/ghissue/blob/main/issue.go#L11-L15>)

Issue is a GitHub issue.
Expand All @@ -116,6 +117,7 @@ type Issue struct {
}
```

<a name="NewIssue"></a>
### func [NewIssue](<https://github.com/atomicgo/ghissue/blob/main/issue.go#L18>)

```go
Expand All @@ -124,6 +126,7 @@ func NewIssue(repo Repository, title, body string) Issue

NewIssue creates a new issue.

<a name="Issue.GetCreateURL"></a>
### func \(Issue\) [GetCreateURL](<https://github.com/atomicgo/ghissue/blob/main/issue.go#L27>)

```go
Expand All @@ -132,6 +135,7 @@ func (issue Issue) GetCreateURL() string

GetCreateURL returns the URL to create an issue.

<a name="Issue.Open"></a>
### func \(Issue\) [Open](<https://github.com/atomicgo/ghissue/blob/main/issue.go#L32>)

```go
Expand All @@ -140,6 +144,7 @@ func (issue Issue) Open() error

Open opens the "create issue" menu on GitHub in the browser.

<a name="Repository"></a>
## type [Repository](<https://github.com/atomicgo/ghissue/blob/main/repository.go#L10-L13>)

Repository is a GitHub repository.
Expand All @@ -151,6 +156,7 @@ type Repository struct {
}
```

<a name="NewRepository"></a>
### func [NewRepository](<https://github.com/atomicgo/ghissue/blob/main/repository.go#L16>)

```go
Expand All @@ -159,6 +165,7 @@ func NewRepository(owner, name string) Repository

NewRepository creates a new Repository from an owner and repository name.

<a name="Repository.CreateErrorReport"></a>
### func \(Repository\) [CreateErrorReport](<https://github.com/atomicgo/ghissue/blob/main/repository.go#L41>)

```go
Expand All @@ -176,6 +183,7 @@ repo := ghissue.NewRepository("atomicgo", "ghissue")
repo.CreateErrorReport(err)
```

<a name="Repository.NewIssue"></a>
### func \(Repository\) [NewIssue](<https://github.com/atomicgo/ghissue/blob/main/repository.go#L29>)

```go
Expand All @@ -184,6 +192,7 @@ func (repo Repository) NewIssue(title, body string) Issue

NewIssue creates a new issue with a title and body.

<a name="Repository.String"></a>
### func \(Repository\) [String](<https://github.com/atomicgo/ghissue/blob/main/repository.go#L24>)

```go
Expand All @@ -192,8 +201,6 @@ func (repo Repository) String() string

String returns the string representation of the repository.



Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)


Expand Down

0 comments on commit 6213f2f

Please sign in to comment.