Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: tuple replaced by list #5840

Merged
merged 1 commit into from Jun 10, 2019

Conversation

Projects
None yet
3 participants
@badeadan
Copy link
Contributor

commented Jun 4, 2019

What this PR does / why we need it:
All list functions also work on tuple (implemented in Sprig as list, see https://github.com/Masterminds/sprig/blob/2625cd487a689ca112e1301a58b89b347ba2c994/functions.go#L237 ) and for all purposes a 'tuple' is a 'list'. Replace documentation ref. to 'tuple' with 'list' so there is no need to explain what a tuple is.

Special notes for your reviewer:
Behaviour-wise 'list' and associated functions return tuples because values are immutable:

  {{ $t := tuple 1 2 -}}
  {{- $t_plus := append $t 3 -}}
  {{ $l := list 4 5 -}}
  {{- $l_plus := append $l 6 -}}
  t: {{ $t }}
  t_plus: {{ $t_plus }}
  l: {{ $l }}
  l_plus: {{ $l_plus }}

renders to (note append on a list should update and return source list):

  t: [1 2]
  t_plus: [1 2 3]
  l: [4 5]
  l_plus: [4 5 6]

where $l is not updated after append as expected. However I think just using 'list' is clearer.

If applicable:

  • this PR contains documentation
  • this PR contains unit tests
  • this PR has been tested for backwards compatibility
doc: tuple replaced by list
Built-in function 'tuple' is implemented in Sprig as 'list'.
(see https://github.com/Masterminds/sprig/blob/2625cd487a689ca112e1301a58b89b347ba2c994/functions.go#L237 )

Replace documentation references to 'tuple' with 'list' so there
is no need to explain what a tuple is.

Signed-off-by: Daniel Badea <daniel.badea@windriver.com>

@helm-bot helm-bot added the size/S label Jun 4, 2019

@bacongobbler
Copy link
Member

left a comment

This function seems to have been part of sprig for quite some time, which means this documentation LGTM as it applies to more than just the latest version of Helm.

@bacongobbler bacongobbler merged commit 3bd6e9f into helm:master Jun 10, 2019

2 checks passed

DCO DCO
Details
ci/circleci: build Your tests passed on CircleCI!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.