Merge pull request #43 from thaJeztah/deprecate_ErrInvalidState

thaJeztah · web-flow · commit 479388643c79 · 2023-05-02T12:20:12.000+02:00
deprecate ErrInvalidState
diff --git a/term.go b/term.go
@@ -14,6 +14,8 @@ import (
 )
 
 // ErrInvalidState is returned if the state of the terminal is invalid.
+//
+// Deprecated: ErrInvalidState is no longer used.
 var ErrInvalidState = errors.New("Invalid terminal state")
 
 // State represents the state of the terminal.
@@ -55,7 +57,7 @@ func IsTerminal(fd uintptr) bool {
 // to a previous state.
 func RestoreTerminal(fd uintptr, state *State) error {
 	if state == nil {
-		return ErrInvalidState
+		return errors.New("invalid terminal state")
 	}
 	return tcset(fd, &state.termios)
 }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ import (`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`// ErrInvalidState is returned if the state of the terminal is invalid.`
	`17`	`+//`
	`18`	`+// Deprecated: ErrInvalidState is no longer used.`
`17`	`19`	`var ErrInvalidState = errors.New("Invalid terminal state")`
`18`	`20`
`19`	`21`	`// State represents the state of the terminal.`
`@@ -55,7 +57,7 @@ func IsTerminal(fd uintptr) bool {`
`55`	`57`	`// to a previous state.`
`56`	`58`	`func RestoreTerminal(fd uintptr, state *State) error {`
`57`	`59`	`if state == nil {`
`58`		`- return ErrInvalidState`
	`60`	`+ return errors.New("invalid terminal state")`
`59`	`61`	`}`
`60`	`62`	`return tcset(fd, &state.termios)`
`61`	`63`	`}`