From 1da2212a9de64671edb17f727b937215cc252309 Mon Sep 17 00:00:00 2001 From: Daniel Lipovetsky Date: Wed, 16 Dec 2020 21:44:43 -0800 Subject: [PATCH] Add explanatory comments to action.List and action.History While the comments may seem to state the obvious to someone with helm CLI experience, an SDK-first user may find these comments helpful. Signed-off-by: Daniel Lipovetsky --- pkg/action/history.go | 3 +++ pkg/action/list.go | 3 +++ 2 files changed, 6 insertions(+) diff --git a/pkg/action/history.go b/pkg/action/history.go index f4043609c..0430aaf7a 100644 --- a/pkg/action/history.go +++ b/pkg/action/history.go @@ -26,6 +26,9 @@ import ( // History is the action for checking the release's ledger. // // It provides the implementation of 'helm history'. +// It returns all the revisions for a specific release. +// To list up to one revision of every release in one specific, or in all, +// namespaces, see the List action. type History struct { cfg *Configuration diff --git a/pkg/action/list.go b/pkg/action/list.go index ebbc56b01..c9e6e364a 100644 --- a/pkg/action/list.go +++ b/pkg/action/list.go @@ -98,6 +98,9 @@ const ( // List is the action for listing releases. // // It provides, for example, the implementation of 'helm list'. +// It returns no more than one revision of every release in one specific, or in +// all, namespaces. +// To list all the revisions of a specific release, see the History action. type List struct { cfg *Configuration