-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Always refer to "finally" tasks 📖 #4090
Conversation
After writing this out im kinda leaning toward (2) instead - always saying "final" tasks, i.e. "final tasks" are tasks in the "finally section", but it seems like that might increase the confusion that @Srivaralakshmi was describing 🤔 /hold |
I lean towards (1), the change you've made. For the following reasons:
I realize these are all quite personal opinions, and informed by experience with the project rather than new user glasses. My 2 cents. |
/approve |
44a6ff9
to
74cda66
Compare
I've made one more tweak which might help: instead of saying "finally tasks" i've added code block markup: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are several spots with ``finally task
instead of `finally` tasks
that is, there's double code markup -- around "finally" and around "finally tasks"
otherwise looks great 👍🏾
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreeing on (1) too 👼🏼
This commit changes all references to "final tasks" and "finally tasks" to `finally` tasks". We were using a mix of "final tasks" and "finally tasks" to refer to these tasks, so this commit is making us consistently use one version. "finally tasks" is less grammatically correct that "final tasks" because finally is an adverb - "finally tasks" only makes sense if "finally tasks" is considered short for "finally tasks in a pipeline". We're working around this by using code block syntax to indicate that `finally` is a symbol in the Pipeline spec, and not just the adverb "finally". Another option sould be to go the other way and always use "final tasks" (and never say "finally tasks"). However if we do this, @Srivaralakshmi pointed out in tektoncd#4086 that this may make it confusing in that reading something like 'the final tasks' may make a user expect to see a seciton in the pipeline called `final` instead of the actual section `finally`. We have another option which is to consider `finally`- an adverb - a bad name for that section of the Pipeline spec and change it to `final`. My understanding of the syntax is a bit different, e.g.: ```yaml spec: tasks: - name: tests taskRef: name: integration-test final: - name: cleanup-test taskRef: name: cleanup ``` However that would be a big change (tho pre-v1 would be the time to do it!) and `finally` is consistent with how this kind of functionality is expressed in languages like Python. (Also I understand the finally section to be saying: once all of the above is done, finally run clean-test, and not to say "cleanup-test is a finally kind of task".) The last option would be to support both final and finally but that feels to me like it would be even more confusing.
74cda66
to
b038907
Compare
/hold cancel |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jerop, sbwsg, vdemeester The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/lgtm |
fixes #4086 |
thanks a bunch @bobcatfish for making it read better 😸 |
Changes
This commit changes all references to "final tasks" to "finally tasks".
We were using a mix of "final tasks" and "finally tasks" to refer to
these tasks, so this commit is making us consistently use one version.
However "finally tasks" is less grammatically correct that "final tasks"
because finally is an adverb - "finally tasks" only makes sense if
"finally tasks" is considered short for "finally tasks in a pipeline".
Another option sould be to go the other way and always use "final tasks"
(and never say "finally tasks"). However if we do this, @Srivaralakshmi
pointed out in #4086 that
this may make it confusing in that reading something like 'the final tasks'
may make a user expect to see a seciton in the pipeline called
final
instead of the actual section
finally
.We have another option which is to consider
finally
- an adverb - abad name for that section of the Pipeline spec and change it to
final
.My understanding of the syntax is a bit different, e.g.:
However that would be a big change (tho pre-v1 would be
the time to do it!) and
finally
is consistent with how this kind offunctionality is expressed in languages like Python.
(Also I understand the finally section to be saying: once all of the above is
done, finally run clean-test, and not to say "cleanup-test is a finally
kind of task". )
The last option would be to support both final and finally but that
feels to me like it would be even more confusing.
/kind documentation
Question for the reviewers: which approach do you think we should take:
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes