From 77d282ac9b7cc010cfaa1115ba6ba176dd476793 Mon Sep 17 00:00:00 2001 From: Oscar Del Ben Date: Sat, 7 Jul 2012 16:06:08 -0700 Subject: [PATCH] Improve documentation of Continuation Add links to Kernel#callcc for cross reference. Improve formatting. --- cont.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/cont.c b/cont.c index 83769ab..dee7d16 100644 --- a/cont.c +++ b/cont.c @@ -799,11 +799,11 @@ cont_restore_0(rb_context_t *cont, VALUE *addr_in_prev_frame) /* * Document-class: Continuation * - * Continuation objects are generated by Kernel#callcc, - * after having required continuation. They hold + * Continuation objects are generated by Kernel#callcc, + * after having +require+d continuation. They hold * a return address and execution context, allowing a nonlocal return * to the end of the callcc block from anywhere within a - * program. Continuations are somewhat analogous to a structured + * program. Continuations are somewhat analogous to a structured * version of C's setjmp/longjmp (although they contain * more state, so you might consider them closer to threads). * @@ -849,15 +849,15 @@ cont_restore_0(rb_context_t *cont, VALUE *addr_in_prev_frame) * call-seq: * callcc {|cont| block } -> obj * - * Generates a Continuation object, which it passes to + * Generates a Continuation object, which it passes to * the associated block. You need to require * 'continuation' before using this method. Performing a - * cont.call will cause the callcc + * cont.call will cause the #callcc * to return (as will falling through the end of the block). The - * value returned by the callcc is the value of the + * value returned by the #callcc is the value of the * block, or the value passed to cont.call. See - * class Continuation for more details. Also see - * Kernel::throw for an alternative mechanism for + * class Continuation for more details. Also see + * Kernel#throw for an alternative mechanism for * unwinding a call stack. */ -- 1.7.11