aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-fail.3
blob: 134ee527c323914de06b29d2b51b1a5f8a4637b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH fail 3 2025-09-06 "Tomo man-pages"
.SH NAME
fail \- abort the program
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI fail\ :\ func(message:\ Text\ ->\ Abort)
.fi
.SH DESCRIPTION
Prints a message to the console, aborts the program, and prints a stack trace.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
message	Text	The error message to print. 	-
.TE
.SH RETURN
Nothing, aborts the program.

.SH EXAMPLES
.EX
fail("Oh no!")
.EE