upstream/helm
1
0
Fork 0
mirror of https://github.com/helm/helm.git synced 2026-03-18 08:40:09 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

ref(pkg/chartutil): improve comment for PathValue

Browse source 
Make comment for PathValue more explanatory.
This commit is contained in:
Sam Leavens 2017-07-20 13:59:28 -07:00
parent cf09e344d1
commit f7ca52dfc8
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
pkg/chartutil/values.go
View file

@ -388,7 +388,13 @@ func istable(v interface{}) bool {
return ok
}
// PathValue takes a yaml path with . notation and returns the value if exists
// PathValue takes a path that traverses a YAML structure and returns the value at the end of that path.
// The path starts at the root of the YAML structure and is comprised of YAML keys separated by periods.
// Given the following YAML data the value at path "chapter.one.title" is "Loomings".
//
// chapter:
// one:
// title: "Loomings"
func (v Values) PathValue(ypath string) (interface{}, error) {
if len(ypath) == 0 {
return nil, errors.New("YAML path string cannot be zero length")