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.

Sign up for GitHub

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

Jump to bottom

Suggestion: References of WhenExpressions should be changed to when expressions #4098

Closed
Srivaralakshmi opened this issue Jul 15, 2021 · 5 comments · Fixed by #4104
Closed

Suggestion: References of WhenExpressions should be changed to when expressions #4098

Srivaralakshmi opened this issue Jul 15, 2021 · 5 comments · Fixed by #4104
Assignees
@jerop
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@Srivaralakshmi
Copy link

Srivaralakshmi commented Jul 15, 2021 •
edited
Loading

Expected Behavior: References of WhenExpressions in the documentation should be changed to when expressions.

Actual Behavior: The when expression resource is referred in the documentation as WhenExpressions.

Reason for the request:

  • Backticks are used to refer to code in the YAML. In the YAML only when is mentioned, whenExpressions are not mentioned anywhere. When we refer to when expressions in the documentation, it is weird to say: WhenExpressions. Instead it is easier to use when expressions in the documentation.
@Srivaralakshmi Srivaralakshmi added the kind/bug Categorizes issue or PR as related to a bug. label Jul 15, 2021
@Srivaralakshmi Srivaralakshmi changed the title References of WhenExpressions must be changed to WhenExpression References of WhenExpressions should be changed to WhenExpression Jul 15, 2021
@ghost
Copy link

ghost commented Jul 15, 2021

I'm not quite sure what you mean by "when expression is a resource", could you clarify a bit? I think of them as the name of a data structure but don't totally understand why we should hold ourselves to always using the name single-case in our documentation. The plural of WhenExpression is WhenExpressions :) It might help if you could point to specific docs and describe specifically what it is you think is misrepresented or incorrect about the usage.

I'm going to switch this to kind/documentation rather than kind/bug if that's ok. The bug label is useful for classifying and aggregating reports of misbehaviour in the execution of Tekton Pipelines and I think this issue is related entirely to the language we're using in our docs?

@ghost ghost added kind/documentation Categorizes issue or PR as related to documentation. and removed kind/bug Categorizes issue or PR as related to a bug. labels Jul 15, 2021
@Srivaralakshmi Srivaralakshmi changed the title References of WhenExpressions should be changed to WhenExpression Suggestion: References of WhenExpressions should be changed to WhenExpression Jul 15, 2021
@Preeticp
Copy link

@Srivaralakshmi is this what you mean? Expected Behavior: References of WhenExpressions in the documentation should be changed to when expression/expressions.

@Srivaralakshmi Srivaralakshmi changed the title Suggestion: References of WhenExpressions should be changed to WhenExpression Suggestion: References of WhenExpressions should be changed to when expressions Jul 15, 2021
@Srivaralakshmi
Copy link
Author

@sbwsg Thank you very much for the response. I have updated the description and the issue title. Please take a look.

@ghost
Copy link

ghost commented Jul 15, 2021

👍 this looks good to me, thanks for the update!

jerop added a commit to jerop/pipeline that referenced this issue Jul 19, 2021
@jerop
docs: rename whenexpressions to when expressions
aadebe9 
this commit changes references to `WhenExpressions` in documentation
to `when` expressions

we use the field `when` in the `pipelines` (expressions is not used) so
to make it less confusing to users, we need to rename

this change applies only to the documentation, it doesn't impact the code

closes tektoncd#3940
closes tektoncd#4098
@jerop jerop mentioned this issue Jul 19, 2021
Merged
5 tasks
@bobcatfish
Copy link
Collaborator

/assign jerop

tekton-robot pushed a commit that referenced this issue Jul 21, 2021
@jerop @tekton-robot
docs: rename whenexpressions to when expressions
1a14883 
this commit changes references to `WhenExpressions` in documentation
to `when` expressions

we use the field `when` in the `pipelines` (expressions is not used) so
to make it less confusing to users, we need to rename

this change applies only to the documentation, it doesn't impact the code

closes #3940
closes #4098
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jerop jerop

Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: rename whenexpressions to when expressions jerop/pipeline
4 participants
@bobcatfish @Preeticp @jerop @Srivaralakshmi