Skip to content

Commit 0ed0d1c

Browse files
jmattheiseternal-flame-AD
authored andcommitted
add clearification on location
1 parent d315cee commit 0ed0d1c

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

displayer.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import "net/url"
66
// The text will appear on the plugin details page and can be multi-line.
77
// Markdown syntax is allowed. Good for providing dynamically generated instructions to the user.
88
// Location is the current location the user is accessing the API from, nil if not recoverable.
9+
// Location contains the path to the display api endpoint, you may only need the base url.
10+
// Example: https://gotify.net/plugin/5/display
911
type Displayer interface {
1012
Plugin
1113
GetDisplay(location *url.URL) string

0 commit comments

Comments
 (0)