about summary refs log tree commit homepage
path: root/lib/rainbows/fiber/io/pipe.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rainbows/fiber/io/pipe.rb')
-rw-r--r--lib/rainbows/fiber/io/pipe.rb7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/rainbows/fiber/io/pipe.rb b/lib/rainbows/fiber/io/pipe.rb
index c7ae508..59114d7 100644
--- a/lib/rainbows/fiber/io/pipe.rb
+++ b/lib/rainbows/fiber/io/pipe.rb
@@ -1,7 +1,12 @@
 # -*- encoding: binary -*-
 # A Fiber-aware Pipe class, gives users the illusion of a synchronous
 # interface that yields away from the current Fiber whenever
-# the underlying descriptor is blocked on reads or write
+# the underlying descriptor is blocked on reads or write.
+#
+# It's not recommended to use any of this in your applications
+# unless you're willing to accept breakage.  Most of this is very
+# difficult-to-use, fragile and we don't have much time to devote to
+# supporting these in the future.
 class Rainbows::Fiber::IO::Pipe < Kgio::Pipe
   include Rainbows::Fiber::IO::Methods
 end