Add comment to displayUsers

Emyrk · Emyrk · commit 77f489010ccf · 2022-05-13T10:01:58.000-05:00
diff --git a/cli/users.go b/cli/users.go
@@ -22,6 +22,9 @@ func users() *cobra.Command {
 	return cmd
 }
 
+// DisplayUsers will return a table displaying all users passed in.
+// filterColumns must be a subset of the user fields and will determine which
+// columns to display
 func DisplayUsers(filterColumns []string, users ...codersdk.User) string {
 	tableWriter := cliui.Table()
 	header := table.Row{"ID", "Username", "Email", "Created At", "Status"}

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ func users() *cobra.Command {`
`22`	`22`	`return cmd`
`23`	`23`	`}`
`24`	`24`
	`25`	`+// DisplayUsers will return a table displaying all users passed in.`
	`26`	`+// filterColumns must be a subset of the user fields and will determine which`
	`27`	`+// columns to display`
`25`	`28`	`func DisplayUsers(filterColumns []string, users ...codersdk.User) string {`
`26`	`29`	`tableWriter := cliui.Table()`
`27`	`30`	`header := table.Row{"ID", "Username", "Email", "Created At", "Status"}`