aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Joiner <anacrolix@gmail.com>2020-09-10 09:52:04 +1000
committerMatt Joiner <anacrolix@gmail.com>2020-09-10 09:52:04 +1000
commitdcec1d6e54815972b4fb2911aec39148311364a6 (patch)
tree78b63deb199db5a0cec48578518dc2341dcc624d
parentMove some benchmarks to be external tests (diff)
downloadstm-dcec1d6e54815972b4fb2911aec39148311364a6.tar.gz
stm-dcec1d6e54815972b4fb2911aec39148311364a6.tar.xz
Document that Operation return value isn't in the examples
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 18455bd..bd518ba 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,9 @@ applications in Go. If you find this package useful, please tell us about it!
## Examples
+Note that `Operation` now returns a value of type `interface{}`, which isn't included in the examples
+throughout the documentation yet. See the type signatures for `Atomically` and `Operation`.
+
Here's some example code that demonstrates how to perform common operations:
```go