add document comments to methods of HaltError

itchyny · Apr 1, 2024 · 79e6f53 · 79e6f53
1 parent 13da5a1
commit 79e6f53
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/error.go b/error.go
@@ -193,10 +193,13 @@ func (err *HaltError) Error() string {
 	return "halt " + (*exitCodeError)(err).Error()
 }
 
+// Value returns the value of the error. This implements [ValueError],
+// but halt error is not catchable by try-catch.
 func (err *HaltError) Value() any {
 	return (*exitCodeError)(err).Value()
 }
 
+// ExitCode returns the exit code of the error.
 func (err *HaltError) ExitCode() int {
 	return (*exitCodeError)(err).ExitCode()
 }