diff options
author | Samuel Williams <samuel.williams@oriontransfer.co.nz> | 2021-11-10 15:42:57 +1300 |
---|---|---|
committer | Samuel Williams <samuel.williams@oriontransfer.co.nz> | 2021-11-10 19:21:05 +1300 |
commit | 81d0ce7e97af74a2086e143f9e349ee519bd1c4d (patch) | |
tree | 873f5bed9e2805e2d820923311d945898c566008 /doc | |
parent | 4b8903421828cb9d4de139180563ae8d8f04e1ab (diff) |
Mark IO::Buffer as experimental.
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/4621
Diffstat (limited to 'doc')
-rw-r--r-- | doc/fiber.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/fiber.md b/doc/fiber.md index f0785d8ae6..a334faf739 100644 --- a/doc/fiber.md +++ b/doc/fiber.md @@ -83,6 +83,7 @@ class Scheduler end # Read from the given io into the specified buffer. + # WARNING: Experimental hook! Do not use in production code! # @parameter io [IO] The io to read from. # @parameter buffer [IO::Buffer] The buffer to read into. # @parameter length [Integer] The minimum amount to read. @@ -90,6 +91,7 @@ class Scheduler end # Write from the given buffer into the specified IO. + # WARNING: Experimental hook! Do not use in production code! # @parameter io [IO] The io to write to. # @parameter buffer [IO::Buffer] The buffer to write from. # @parameter length [Integer] The minimum amount to write. |