Skip to content

Commit 6efc0b7

Browse files
committed
Fix formatting of release notes.
1 parent 5f6bab4 commit 6efc0b7

1 file changed

Lines changed: 28 additions & 29 deletions

File tree

releases.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ queue.dequeue # => nil
7878

7979
## v2.25.0
8080

81-
- Added support for `io_select` hook in the fiber scheduler, allowing non-blocking `IO.select` operations. This enables better integration with code that uses `IO.select` for multiplexing IO operations.
81+
- Added support for `io_select` hook in the fiber scheduler, allowing non-blocking `IO.select` operations. This enables better integration with code that uses `IO.select` for multiplexing IO operations.
8282

8383
### Use `IO::Event::WorkerPool` for Blocking Operations
8484

@@ -105,9 +105,8 @@ end
105105

106106
## v2.24.0
107107

108-
- Ruby v3.1 support is dropped.
109-
- `Async::Wrapper` which was previously deprecated, is now removed.
110-
- `Async::Barrier` now waits in order of completion rather than order of creation. This means that if you create a barrier with 3 tasks, and one of them completes (or fails) before the others, it will be the first to be yielded to the barrier.
108+
- Ruby v3.1 support is dropped.
109+
- `Async::Wrapper` which was previously deprecated, is now removed.
111110

112111
### Flexible Timeouts
113112

@@ -139,7 +138,7 @@ end
139138

140139
## v2.23.0
141140

142-
- Rename `ASYNC_SCHEDULER_DEFAULT_WORKER_POOL` to `ASYNC_SCHEDULER_WORKER_POOL`.
141+
- Rename `ASYNC_SCHEDULER_DEFAULT_WORKER_POOL` to `ASYNC_SCHEDULER_WORKER_POOL`.
143142

144143
### Fiber Stall Profiler
145144

@@ -169,7 +168,7 @@ Ruby 3.4 will feature a new fiber scheduler hook, `blocking_operation_wait` whic
169168

170169
The Async scheduler optionally supports this feature using a worker pool, by using the following environment variable:
171170

172-
ASYNC_SCHEDULER_WORKER_POOL=true
171+
ASYNC_SCHEDULER_WORKER_POOL=true
173172

174173
This will cause the scheduler to use a worker pool for general blocking operations, rather than blocking the event loop.
175174

@@ -189,21 +188,21 @@ To take advantage of this feature, you will need to introduce your own `config/t
189188

190189
Occasionally on issues, I encounter people asking for help and I need more information. Pressing Ctrl-C to exit a hung program is common, but it usually doesn't provide enough information to diagnose the problem. Setting the `CONSOLE_LEVEL=debug` environment variable will now print additional information about the scheduler when you interrupt it, including a backtrace of the current tasks.
191190

192-
> CONSOLE_LEVEL=debug bundle exec ruby ./test.rb
193-
^C 0.0s debug: Async::Reactor [oid=0x974] [ec=0x988] [pid=9116] [2024-11-08 14:12:03 +1300]
194-
| Scheduler interrupted: Interrupt
195-
| #<Async::Reactor:0x0000000000000974 1 children (running)>
196-
| #<Async::Task:0x000000000000099c /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:185:in `transfer' (running)>
197-
| → /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:185:in `transfer'
198-
| /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:185:in `block'
199-
| /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:207:in `kernel_sleep'
200-
| /Users/samuel/Developer/socketry/async/test.rb:7:in `sleep'
201-
| /Users/samuel/Developer/socketry/async/test.rb:7:in `sleepy'
202-
| /Users/samuel/Developer/socketry/async/test.rb:12:in `block in <top (required)>'
203-
| /Users/samuel/Developer/socketry/async/lib/async/task.rb:197:in `block in run'
204-
| /Users/samuel/Developer/socketry/async/lib/async/task.rb:420:in `block in schedule'
205-
/Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:317:in `select': Interrupt
206-
... (backtrace continues) ...
191+
> CONSOLE_LEVEL=debug bundle exec ruby ./test.rb
192+
^C 0.0s debug: Async::Reactor [oid=0x974] [ec=0x988] [pid=9116] [2024-11-08 14:12:03 +1300]
193+
| Scheduler interrupted: Interrupt
194+
| #<Async::Reactor:0x0000000000000974 1 children (running)>
195+
| #<Async::Task:0x000000000000099c /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:185:in `transfer' (running)>
196+
| → /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:185:in `transfer'
197+
| /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:185:in `block'
198+
| /Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:207:in `kernel_sleep'
199+
| /Users/samuel/Developer/socketry/async/test.rb:7:in `sleep'
200+
| /Users/samuel/Developer/socketry/async/test.rb:7:in `sleepy'
201+
| /Users/samuel/Developer/socketry/async/test.rb:12:in `block in <top (required)>'
202+
| /Users/samuel/Developer/socketry/async/lib/async/task.rb:197:in `block in run'
203+
| /Users/samuel/Developer/socketry/async/lib/async/task.rb:420:in `block in schedule'
204+
/Users/samuel/Developer/socketry/async/lib/async/scheduler.rb:317:in `select': Interrupt
205+
... (backtrace continues) ...
207206

208207
This gives better visibility into what the scheduler is doing, and should help diagnose issues.
209208

@@ -220,19 +219,19 @@ Async{raise "Boom"}
220219

221220
Will now use `Kernel#warn` to print the task failure warning:
222221

223-
#<Async::Task:0x00000000000012d4 /home/samuel/Developer/socketry/async/lib/async/task.rb:104:in `backtrace' (running)>
224-
Task may have ended with unhandled exception.
225-
(irb):4:in `block in <top (required)>': Boom (RuntimeError)
226-
from /home/samuel/Developer/socketry/async/lib/async/task.rb:197:in `block in run'
227-
from /home/samuel/Developer/socketry/async/lib/async/task.rb:420:in `block in schedule'
222+
#<Async::Task:0x00000000000012d4 /home/samuel/Developer/socketry/async/lib/async/task.rb:104:in `backtrace' (running)>
223+
Task may have ended with unhandled exception.
224+
(irb):4:in `block in <top (required)>': Boom (RuntimeError)
225+
from /home/samuel/Developer/socketry/async/lib/async/task.rb:197:in `block in run'
226+
from /home/samuel/Developer/socketry/async/lib/async/task.rb:420:in `block in schedule'
228227

229228
## v2.18.0
230229

231-
- Add support for `Sync(annotation:)`, so that you can annotate the block with a description of what it does, even if it doesn't create a new task.
230+
- Add support for `Sync(annotation:)`, so that you can annotate the block with a description of what it does, even if it doesn't create a new task.
232231

233232
## v2.17.0
234233

235-
- Introduce `Async::Queue#push` and `Async::Queue#pop` for compatibility with `::Queue`.
234+
- Introduce `Async::Queue#push` and `Async::Queue#pop` for compatibility with `::Queue`.
236235

237236
## v2.16.0
238237

@@ -249,7 +248,7 @@ reactor = Async::Reactor.new # internally calls Fiber.set_scheduler
249248

250249
# This should run in the above reactor, rather than creating a new one.
251250
Async do
252-
puts "Hello World"
251+
puts "Hello World"
253252
end
254253
```
255254

0 commit comments

Comments
 (0)