Skip to content

Commit 3da7b09

Browse files
docs(perms): add godoc to perms package (#29)
1 parent 692ce6b commit 3da7b09

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

perms/perms.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Package perms provides methods for managing user app and administrative permissions.
12
package perms
23

34
import (
@@ -30,7 +31,7 @@ func List(c *deis.Client, appID string) ([]string, error) {
3031
return users.Users, nil
3132
}
3233

33-
// ListAdmins lists administrators.
34+
// ListAdmins lists deis platform administrators.
3435
func ListAdmins(c *deis.Client, results int) ([]string, int, error) {
3536
body, count, err := c.LimitedRequest("/v2/admin/perms/", results)
3637

@@ -52,7 +53,7 @@ func ListAdmins(c *deis.Client, results int) ([]string, int, error) {
5253
return usersList, count, nil
5354
}
5455

55-
// New adds a user to an app.
56+
// New gives a user access to an app.
5657
func New(c *deis.Client, appID string, username string) error {
5758
return doNew(c, fmt.Sprintf("/v2/apps/%s/perms/", appID), username)
5859
}

0 commit comments

Comments
 (0)