Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

README: Updated documentation to reflect SEND/RECV changes.

  • Loading branch information...
commit 9bea73a385f3df765336424fd2651e161a8f44d0 1 parent f8e3b9a
Josh Marchán authored October 11, 2009

Showing 1 changed file with 6 additions and 6 deletions. Show diff stats Hide diff stats

  1. 12  README.mkdn
12  README.mkdn
Source Rendered
@@ -85,9 +85,9 @@ Channel API
85 85
   Note that this value might be further limited by memory constraints.
86 86
 
87 87
 
88  
-*[generic function]* `send channel value &optional blockp`
  88
+*[generic function]* `send channel value &key`
89 89
 
90  
-*[method]* `send (channel channel) value &optional (blockp t)`
  90
+*[method]* `send (channel channel) value &key (blockp t)`
91 91
 
92 92
   Tries to send VALUE into CHANNEL. If the channel is unbufferd or buffered but full, this operation
93 93
   will block until RECV is called on the channel. Returns the channel that the value was sent into.
@@ -95,7 +95,7 @@ Channel API
95 95
   block.
96 96
 
97 97
 
98  
-*[method]* `send (channels sequence) value &optional (blockp t)`
  98
+*[method]* `send (channels sequence) value &key (blockp t)`
99 99
 
100 100
   SEND may be used on a sequence of channels. SEND will linearly attempt to send VALUE into one of
101 101
   the channels in the sequence. It will return immediately as soon as it is able to send VALUE into
@@ -103,9 +103,9 @@ Channel API
103 103
   otherwise, it will return NIL when the sequence has been exhausted.
104 104
 
105 105
 
106  
-*[generic function]* `recv channel &optional blockp`
  106
+*[generic function]* `recv channel &key`
107 107
 
108  
-*[method]* `recv (channel channel) &optional (blockp t)`
  108
+*[method]* `recv (channel channel) &key (blockp t)`
109 109
 
110 110
   Tries to receive a value from CHANNEL. If the channel is unbuffered, or buffered but empty, this
111 111
   operation will block until SEND is called on the channel. Returns two values: 1. The value
@@ -113,7 +113,7 @@ Channel API
113 113
   operation will not block, and will return `(values NIL NIL)` if attempting it would block.
114 114
 
115 115
 
116  
-*[method]* `recv (channel sequence) &optional (blockp t)`
  116
+*[method]* `recv (channel sequence) &key (blockp t)`
117 117
 
118 118
   RECV may be used on a sequence of channels. RECV will linearly attempt to receive a value from
119 119
   one of the channels in teh sequence. It will return immediately as soon as one channel has a value

0 notes on commit 9bea73a

Please sign in to comment.
Something went wrong with that request. Please try again.