From 4aeec8a4aaee1b54f2b09c97845b89d0d54809c4 Mon Sep 17 00:00:00 2001
From: Yongxuan Zhang <yongxuanzhang@google.com>
Date: Wed, 27 Jul 2022 20:56:03 +0000
Subject: [PATCH] Remove not supported results and params variables doc

This commit updates the results and params related variables doc. In the
doc for results, the square bracket reference is not currently supported
for all types of results, these should be removed to avoid user
confusion before issue #4910 is done. Meanwhile we add star notation for
param reference as a whole.
---
 docs/variables.md | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/docs/variables.md b/docs/variables.md
index f4967dde0b1..8822015fd4d 100644
--- a/docs/variables.md
+++ b/docs/variables.md
@@ -19,21 +19,16 @@ For instructions on using variable substitutions see the relevant section of [th
 | `params.<param name>` | The value of the parameter at runtime. |
 | `params['<param name>']` | (see above) |
 | `params["<param name>"]` | (see above) |
+| `params.<param name>[*]` | Get the whole param array or object.|
+| `params['<param name>'][*]` | (see above) |
+| `params["<param name>"][*]` | (see above) |
 | `params.<param name>[i]` | Get the i-th element of param array. This is alpha feature, set `enable-api-fields` to `alpha`  to use it.|
 | `params['<param name>'][i]` | (see above) |
 | `params["<param name>"][i]` | (see above) |
 | `tasks.<taskName>.results.<resultName>` | The value of the `Task's` result. Can alter `Task` execution order within a `Pipeline`.) |
-| `tasks.<taskName>.results['<resultName>']` | (see above)) |
-| `tasks.<taskName>.results["<resultName>"]` | (see above)) |
 | `tasks.<taskName>.results.<resultName>[i]` | The ith value of the `Task's` array result. Can alter `Task` execution order within a `Pipeline`.) |
-| `tasks.<taskName>.results['<resultName>'][i]` | (see above)) |
-| `tasks.<taskName>.results["<resultName>"][i]` | (see above)) |
 | `tasks.<taskName>.results.<resultName>[*]` | The array value of the `Task's` result. Can alter `Task` execution order within a `Pipeline`. Cannot be used in `script`.) |
-| `tasks.<taskName>.results['<resultName>'][*]` | (see above)) |
-| `tasks.<taskName>.results["<resultName>"][*]` | (see above)) |
 | `tasks.<taskName>.results.<resultName>.key` | The `key` value of the `Task's` object result. Can alter `Task` execution order within a `Pipeline`.) |
-| `tasks.<taskName>.results['<resultName>'][key]` | (see above)) |
-| `tasks.<taskName>.results["<resultName>"][key]` | (see above)) |
 | `workspaces.<workspaceName>.bound` | Whether a `Workspace` has been bound or not. "false" if the `Workspace` declaration has `optional: true` and the Workspace binding was omitted by the PipelineRun. |
 | `context.pipelineRun.name` | The name of the `PipelineRun` that this `Pipeline` is running in. |
 | `context.pipelineRun.namespace` | The namespace of the `PipelineRun` that this `Pipeline` is running in. |
@@ -50,6 +45,9 @@ For instructions on using variable substitutions see the relevant section of [th
 | `params.<param name>` | The value of the parameter at runtime. |
 | `params['<param name>']` | (see above) |
 | `params["<param name>"]` | (see above) |
+| `params.<param name>[*]` | Get the whole param array or object.|
+| `params['<param name>'][*]` | (see above) |
+| `params["<param name>"][*]` | (see above) |
 | `params.<param name>[i]` | Get the i-th element of param array. This is alpha feature, set `enable-api-fields` to `alpha`  to use it.|
 | `params['<param name>'][i]` | (see above) |
 | `params["<param name>"][i]` | (see above) |