-
Notifications
You must be signed in to change notification settings - Fork 2
/
doc.go
18 lines (15 loc) · 843 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/*
Package sgf contains various tools for working with SGF files and the SGF trees
within them. Trees are simply a collection of nodes connected together via
parent and child relationships. Each node can have properties, which are keys
with a slice of values. All keys and values are stored as strings.
In general, functions or methods which require a coordinate expect that
coordinate to be supplied as an SGF string. For example, the string "dd" is the
top left hoshi point. Such strings can be generated by the Point() utility
function; e.g. Point(3, 3) returns "dd".
Nodes can be used to generate boards via node.Board(), but editing a board has
no effect on the node that created it. Creating boards is relatively expensive,
but often unnecessary for simple tasks.
New nodes are generally best created with node.Play().
*/
package sgf