Skip to content

Commit d35f4b6

Browse files
committed
Update docs
1 parent 581517e commit d35f4b6

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

doc.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ frontend for your project.
1111
1212
Features
1313
14-
As of AwGo 0.17, all applicable features of Alfred 4.0 are supported.
14+
As of AwGo 0.26, all applicable features of Alfred 4.1 are supported.
1515
1616
The main features are:
1717
@@ -185,12 +185,12 @@ matching algorithm.
185185
Workflow.Filter() sorts feedback Items against the provided query, removing
186186
those that do not match.
187187
188-
Sorting is performed by subpackage fuzzy via the fuzzy.Sortable interface.
189-
190188
See _examples/fuzzy for a basic demonstration, and _examples/bookmarks for a
191189
demonstration of implementing fuzzy.Sortable on your own structs and customising
192190
the fuzzy sort settings.
193191
192+
Fuzzy matching is done by package https://godoc.org/go.deanishe.net/fuzzy
193+
194194
195195
Logging
196196
@@ -208,11 +208,11 @@ and in this case prepends filename:linenumber: to log messages.
208208
Workflow settings
209209
210210
The Config struct (which is included in Workflow as Workflow.Config) provides an
211-
interface to the workflow's settings from the Workflow Environment Variables panel.
212-
https://www.alfredapp.com/help/workflows/advanced/variables/#environment
211+
interface to the workflow's settings from the Workflow Environment Variables panel
212+
(see https://www.alfredapp.com/help/workflows/advanced/variables/#environment).
213213
214214
Alfred exports these settings as environment variables, and you can read them
215-
ad-hoc with the Config.Get*() methods, and save values back to Alfred with
215+
ad-hoc with the Config.Get*() methods, and save values back to Alfred/info.plist with
216216
Config.Set().
217217
218218
Using Config.To() and Config.From(), you can "bind" your own structs to the
@@ -234,7 +234,7 @@ settings in Alfred:
234234
// handle error
235235
}
236236
237-
// Save Options back to Alfred.
237+
// Save Options back to Alfred/info.plist.
238238
if err := cfg.From(opts); err != nil {
239239
// handle error
240240
}
@@ -247,7 +247,7 @@ Alfred actions
247247
248248
The Alfred struct provides methods for the rest of Alfred's AppleScript
249249
API. Amongst other things, you can use it to tell Alfred to open, to search
250-
for a query, or to browse/action files & directories.
250+
for a query, to browse/action files & directories, or to run External Triggers.
251251
252252
See documentation of the Alfred struct for more information.
253253

feedback.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,9 @@ func (a *ArgVars) Arg(s ...string) *ArgVars {
551551
}
552552

553553
// Vars returns ArgVars' variables.
554+
// NOTE: This function only returns variables you have set with ArgVars.Var()
555+
// for export to Alfred during this run. To read variables from the environment,
556+
// use Workflow.Config.
554557
func (a *ArgVars) Vars() map[string]string {
555558
return a.vars
556559
}

0 commit comments

Comments
 (0)