From 29ed05195c42acde581a6f4fe7706e2c6f60a745 Mon Sep 17 00:00:00 2001 From: Ceri Date: Tue, 12 Mar 2024 15:04:00 +0000 Subject: [PATCH] Update docstring. --- errors.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/errors.go b/errors.go index cebb87a..bf876a7 100644 --- a/errors.go +++ b/errors.go @@ -158,7 +158,9 @@ func (p *Error) StackTrace() []uintptr { return out } -// StackString formats the stack as a beautiful string with newlines +// StackString formats the stacks from the terror chain as a string. If we +// encounter more than one terror in the chain with a stack frame, we'll print +// each one, separated by three hyphens on their own line. func (p *Error) StackString() string { var buffer strings.Builder terr := p