serverctl: fix a docstring

knz · knz · commit 209a3433f73f · 2023-08-14T18:55:28.000+02:00
Release note: None
diff --git a/pkg/server/serverctl/shutdown.go b/pkg/server/serverctl/shutdown.go
@@ -22,8 +22,8 @@ func (r ShutdownRequest) ShutdownCause() error {
 	}
 }
 
-// Graceful determines whether the shutdown should be effected via a
-// graceful drain first.
+// TerminateUsingGracefulDrain determines whether the shutdown should
+// be effected via a graceful drain first.
 func (r ShutdownRequest) TerminateUsingGracefulDrain() bool {
 	// As of this patch, none of the existing reasons for shutdown
 	// can be correctly followed by a graceful drain.

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ func (r ShutdownRequest) ShutdownCause() error {`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`
`25`		`-// Graceful determines whether the shutdown should be effected via a`
`26`		`-// graceful drain first.`
	`25`	`+// TerminateUsingGracefulDrain determines whether the shutdown should`
	`26`	`+// be effected via a graceful drain first.`
`27`	`27`	`func (r ShutdownRequest) TerminateUsingGracefulDrain() bool {`
`28`	`28`	`// As of this patch, none of the existing reasons for shutdown`
`29`	`29`	`// can be correctly followed by a graceful drain.`