Skip to content

Commit e686064

Browse files
docs(releases): add godoc for releases (#32)
1 parent e2dabbf commit e686064

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

releases/releases.go

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

34
import (
@@ -28,7 +29,7 @@ func List(c *deis.Client, appID string, results int) ([]api.Release, int, error)
2829
return releases, count, nil
2930
}
3031

31-
// Get a release of an app.
32+
// Get retrieves a release of an app.
3233
func Get(c *deis.Client, appID string, version int) (api.Release, error) {
3334
u := fmt.Sprintf("/v2/apps/%s/releases/v%d/", appID, version)
3435

@@ -50,7 +51,8 @@ func Get(c *deis.Client, appID string, version int) (api.Release, error) {
5051
return release, reqErr
5152
}
5253

53-
// Rollback rolls back an app to a previous release.
54+
// Rollback rolls back an app to a previous release. If version is -1, this rolls back to
55+
// the previous release. Otherwise, roll back to the specified version.
5456
func Rollback(c *deis.Client, appID string, version int) (int, error) {
5557
u := fmt.Sprintf("/v2/apps/%s/releases/rollback/", appID)
5658

0 commit comments

Comments
 (0)