system: some documentation improvements (#10809)

This commit is contained in:
Miran 2019-03-11 11:04:08 +01:00 • committed by GitHub
commit 06f23572d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 1412 additions and 820 deletions

View file

@ -14,7 +14,7 @@ var
errorMessageWriter*: (proc(msg: string) {.tags: [WriteIOEffect], benign,
nimcall.})
## Function that will be called
## instead of stdmsg.write when printing stacktrace.
## instead of `stdmsg.write` when printing stacktrace.
## Unstable API.
proc c_fwrite(buf: pointer, size, n: csize, f: CFilePtr): cint {.
@ -331,8 +331,9 @@ else:
proc stackTraceAvailable*(): bool = result = false
var onUnhandledException*: (proc (errorMsg: string) {.
nimcall.}) ## set this error \
nimcall.}) ## Set this error \
## handler to override the existing behaviour on an unhandled exception.
##
## The default is to write a stacktrace to ``stderr`` and then call ``quit(1)``.
## Unstable API.