From b297ef2d39823ef74e1be98c6f9329e5173af928 Mon Sep 17 00:00:00 2001 From: Mike Curtiss Date: Thu, 16 May 2013 11:16:37 -0700 Subject: [PATCH] Gen apply comment Summary: Comment Test Plan: Builds Reviewed By: tjackson@fb.com FB internal diff: D814986 --- folly/experimental/Gen-inl.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/folly/experimental/Gen-inl.h b/folly/experimental/Gen-inl.h index 6a90d266..e8861d0b 100644 --- a/folly/experimental/Gen-inl.h +++ b/folly/experimental/Gen-inl.h @@ -156,10 +156,10 @@ class GenImpl : public FBounded { /** * apply() - Send all values produced by this generator to given - * handler until the handler returns false. Returns true until the handler - * returns false. GOTCHA: It should return true even if it completes (without - * the handler returning false), as 'Chain' uses the return value of apply - * to determine if it should process the second object in its chain. + * handler until the handler returns false. Returns false if and only if the + * handler returns false. Note: It should return true even if it completes + * (without the handler returning false), as 'Chain' uses the return value of + * apply to determine if it should process the second object in its chain. */ template bool apply(Handler&& handler) const; -- 2.34.1