docs(ffi): fix copy-paste error on hyper_waker_wake (#2604)

2021-07-26 13:18:50 -05:00
parent 19f38b3e7f
commit 6393a0cc03
2 changed files with 6 additions and 2 deletions
--- a/capi/include/hyper.h
+++ b/capi/include/hyper.h
@@ -718,7 +718,9 @@ struct hyper_waker *hyper_context_waker(struct hyper_context *cx);
 void hyper_waker_free(struct hyper_waker *waker);

 /*
- Free a waker that hasn't been woken.
+ Wake up the task associated with a waker.
+
+ NOTE: This consumes the waker. You should not use or free the waker afterwards.
 */
 void hyper_waker_wake(struct hyper_waker *waker);