kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

thread_sync.c: Document exception types

Browse source 
* thread_sync.c (rb_queue_pop, rb_szqueue_push, rb_szqueue_pop):
  Document exception types, ThreadError, raised by Queue and
  SizedQueue.  [Fix GH-1451]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56287 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nobu 2016-09-29 10:34:25 +00:00
parent b1d242406a
commit 325587ee7f
2 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
Thu Sep 29 19:34:23 2016 Pete Higgins <pete@peterhiggins.org>
* thread_sync.c (rb_queue_pop, rb_szqueue_push, rb_szqueue_pop):
Document exception types, ThreadError, raised by Queue and
SizedQueue. [Fix GH-1451]
Thu Sep 29 19:21:02 2016 Pete Higgins <pete@peterhiggins.org>
* thread_sync.c (Init_thread_sync): Remove confusing doc comments,

10
thread_sync.c
View file

@ -824,8 +824,8 @@ queue_pop_should_block(int argc, const VALUE *argv)
* Retrieves data from the queue.
*
* If the queue is empty, the calling thread is suspended until data is pushed
* onto the queue. If +non_block+ is true, the thread isn't suspended, and an
* exception is raised.
* onto the queue. If +non_block+ is true, the thread isn't suspended, and
* +ThreadError+ is raised.
*/
static VALUE
@ -1002,7 +1002,7 @@ szqueue_push_should_block(int argc, const VALUE *argv)
*
* If there is no space left in the queue, waits until space becomes
* available, unless +non_block+ is true. If +non_block+ is true, the
* thread isn't suspended, and an exception is raised.
* thread isn't suspended, and +ThreadError+ is raised.
*/
static VALUE
@ -1056,8 +1056,8 @@ szqueue_do_pop(VALUE self, int should_block)
* Retrieves data from the queue.
*
* If the queue is empty, the calling thread is suspended until data is pushed
* onto the queue. If +non_block+ is true, the thread isn't suspended, and an
* exception is raised.
* onto the queue. If +non_block+ is true, the thread isn't suspended, and
* +ThreadError+ is raised.
*/
static VALUE