Improve bracket documentation
This PR improves documentation of bracket
function in base. It should mention that bracket
is using mask
which requires that the resource release function is uninterruptible. This property holds for hClose
(when used non-concurrently) or Network.Socket.close
, but not for killThread
: threads at times are used as a resource as well, this week I fixed a bug in the code base I work on due to that (see https://github.com/input-output-hk/ouroboros-network/pull/2851).
Please take a few moments to verify that your commits fulfill the following:
-
are either individually buildable or squashed -
have commit messages which describe what they do (referring to Notes and tickets using #NNNN
syntax when appropriate) -
have added source comments describing your change. For larger changes you likely should add a Note and cross-reference it from the relevant places. -
add a testcase to the testsuite. -
replace this message with a description motivating your change
If you have any questions don't hesitate to open your merge request and inquire
in a comment. If your patch isn't quite done yet please do add prefix your MR
title with WIP:
.