Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-18 21:29:18 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix function syntax in headers

Browse source
This commit is contained in:
Justin Ethier 2019-06-13 13:21:30 -04:00
parent 2eeae1d7ed
commit 44ab2b8de5
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/api/cyclone/concurrency.md
View file

@ -31,7 +31,7 @@ If the given object is atomic or already shared it it simply returned. Otherwise
Note this function may trigger a minor GC if a thread-local pair or vector is passed.
### share-all
### share-all!
(share-all!)
@ -58,7 +58,7 @@ Create a new atom referencing `obj`.
Create a new atom in the same manner as `make-atom`. If `obj` is not provided it will default to `#f`.
### atom-1
### atom?
(atom? obj)
@ -70,7 +70,7 @@ Type predicate, returns `#t` if `obj` is an atom and `#f` otherwise.
Dereference an atom by returning its current value.
### swap
### swap!
(swap! atom f . args)
@ -89,7 +89,7 @@ TODO - notes:
;; That means the function can get called multiple times. That means it needs to be a pure function. Another thing is that you can't control the order of the function calls. If multiple threads are swapping to an Atom at the same time, order is out of the window. So make sure your functions are independent of order, like we talked about before.
;;
### compare-and-set
### compare-and-set!
(compare-and-set! atm oldval newval)