-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
22 lines (22 loc) · 1.16 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Package sway provides a convenient interface to the sway window manager.
//
// Its function and type names don’t stutter, and all functions and methods are
// safe for concurrent use (except where otherwise noted). The package does not
// import "unsafe" and hence should be widely applicable.
//
// UNIX socket connections to sway are transparently managed by the package. Upon
// any read/write errors on a UNIX socket, the package transparently retries for
// up to 10 seconds, but only as long as the sway process keeps running.
//
// The package is published in versioned releases, where the major and minor
// version are identical to the sway release the package is compatible with
// (e.g. 4.14 implements the entire documented IPC interface of sway 4.14).
//
// This package will only ever receive additions, so versioning should only be
// relevant to you if you are interested in a recently-introduced IPC feature.
//
// Message type functions and event types are annotated with the sway version in
// which they were introduced. Under the covers, they use AtLeast, so they
// return a helpful error message at runtime if the running sway version is too
// old.
package sway