Skip to content
This repository was archived by the owner on Dec 1, 2021. It is now read-only.

Commit c605e28

Browse files
mrhwickdavecheney
authored andcommitted
Add doc comment for exported Format func (#115)
1 parent ff09b13 commit c605e28

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

stack.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,14 @@ func (f Frame) Format(s fmt.State, verb rune) {
7979
// StackTrace is stack of Frames from innermost (newest) to outermost (oldest).
8080
type StackTrace []Frame
8181

82+
// Format formats the stack of Frames according to the fmt.Formatter interface.
83+
//
84+
// %s lists source files for each Frame in the stack
85+
// %v lists the source file and line number for each Frame in the stack
86+
//
87+
// Format accepts flags that alter the printing of some verbs, as follows:
88+
//
89+
// %+v Prints filename, function, and line number for each Frame in the stack.
8290
func (st StackTrace) Format(s fmt.State, verb rune) {
8391
switch verb {
8492
case 'v':

0 commit comments

Comments
 (0)