gre-ilya/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: correct uv_cancel return value

Browse Source 
There is a minor error about the return value of uv_cancel
for tasks that are already executing. All other parts of the
documentation correctly states that uv_cancel will fail.
This commit is contained in:
m0cg 2025-09-11 14:43:22 +02:00 committed by GitHub
parent 2e86f6b635
commit 0fb35fd0de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/src/guide/threads.rst
View File

@ -258,7 +258,8 @@ up a signal handler for termination.
:lines: 43-
When the user triggers the signal by pressing ``Ctrl+C`` we send
``uv_cancel()`` to all the workers. ``uv_cancel()`` will return ``0`` for those that are already executing or finished.
``uv_cancel()`` to all the workers. ``uv_cancel()`` will return ``0`` for those
tasks that are pending execution and could be cancelled.
.. rubric:: queue-cancel/main.c
.. literalinclude:: ../../code/queue-cancel/main.c