ssh/terminal: use "reports whether" in IsTerminal doc
Go documentation style for boolean funcs is to say:
// Foo reports whether ...
func Foo() bool
(rather than "returns true if")
Change-Id: I6972d123ba99bbf3dbf95e876b45b2ecd98dd07c
Reviewed-on: https://go-review.googlesource.com/c/151257
Run-TryBot: Tobias Klauser <tobias.klauser@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
diff --git a/ssh/terminal/util.go b/ssh/terminal/util.go
index 9a3fb09..3911040 100644
--- a/ssh/terminal/util.go
+++ b/ssh/terminal/util.go
@@ -25,7 +25,7 @@
termios unix.Termios
}
-// IsTerminal returns true if the given file descriptor is a terminal.
+// IsTerminal returns whether the given file descriptor is a terminal.
func IsTerminal(fd int) bool {
_, err := unix.IoctlGetTermios(fd, ioctlReadTermios)
return err == nil
diff --git a/ssh/terminal/util_plan9.go b/ssh/terminal/util_plan9.go
index 799f049..9317ac7 100644
--- a/ssh/terminal/util_plan9.go
+++ b/ssh/terminal/util_plan9.go
@@ -21,7 +21,7 @@
type State struct{}
-// IsTerminal returns true if the given file descriptor is a terminal.
+// IsTerminal returns whether the given file descriptor is a terminal.
func IsTerminal(fd int) bool {
return false
}
diff --git a/ssh/terminal/util_solaris.go b/ssh/terminal/util_solaris.go
index 9e41b9f..3d5f06a 100644
--- a/ssh/terminal/util_solaris.go
+++ b/ssh/terminal/util_solaris.go
@@ -17,7 +17,7 @@
termios unix.Termios
}
-// IsTerminal returns true if the given file descriptor is a terminal.
+// IsTerminal returns whether the given file descriptor is a terminal.
func IsTerminal(fd int) bool {
_, err := unix.IoctlGetTermio(fd, unix.TCGETA)
return err == nil
diff --git a/ssh/terminal/util_windows.go b/ssh/terminal/util_windows.go
index 8618955..6cb8a95 100644
--- a/ssh/terminal/util_windows.go
+++ b/ssh/terminal/util_windows.go
@@ -26,7 +26,7 @@
mode uint32
}
-// IsTerminal returns true if the given file descriptor is a terminal.
+// IsTerminal returns whether the given file descriptor is a terminal.
func IsTerminal(fd int) bool {
var st uint32
err := windows.GetConsoleMode(windows.Handle(fd), &st)
