Skip to content

Commit 0e32b29

Browse files
docs: Improve callback docs
1 parent 19dd205 commit 0e32b29

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

include/secp256k1.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,10 @@ SECP256K1_API void secp256k1_context_set_illegal_callback(
350350
) SECP256K1_ARG_NONNULL(1);
351351

352352
/** Set a callback function to be called when an internal consistency check
353-
* fails. The default is crashing.
353+
* fails.
354+
*
355+
* The default callback writes an error message to stderr and calls abort
356+
* to abort the program.
354357
*
355358
* This can only trigger in case of a hardware failure, miscompilation,
356359
* memory corruption, serious bug in the library, or other error would can

0 commit comments

Comments
 (0)