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

Update docs for trigger-when-paused. #778

Closed
wants to merge 4 commits into from

Conversation

hjoliver
Copy link
Member

@hjoliver hjoliver commented Nov 21, 2024

Companion for cylc/cylc-flow#6192 cylc/cylc-flow#6499

@oliver-sanders - I still need to update the intervention gif animation. Is it possible for you to advise on window size etc. so that I end up with a similar look to your originals, or do I just have to experiment with that?

TODO:

  • update the intervention gif animation

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@hjoliver hjoliver added this to the 8.4.0 milestone Nov 21, 2024
@hjoliver hjoliver self-assigned this Nov 21, 2024
@oliver-sanders
Copy link
Member

@oliver-sanders - I still need to update the intervention gif animiation. Is it possible for you to advise on window size etc. so that I end up with a similar look to your originals, or do I just have to experiment with that?

Some details in this comment:

.. NOTE - Creating screen recordings
* Use the dimensions 650x720 for your recording area.
* On my setup that works out as 72 cols by 40 rows in the terminal.
* Keep it as short as possible without being disorientating.
* Document top-level use cases, don't attempt to cover every
possible intervention.
* I've been installing workflows as "myworkflow".

Something I didn't mention there, but should have, is the terminal theme I used (Gnome - Tango Dark) for Tui recordings.

@hjoliver hjoliver force-pushed the trigger-when-paused branch from 83ac08f to d1f2744 Compare November 28, 2024 03:14
src/glossary.rst Outdated Show resolved Hide resolved
src/glossary.rst Outdated

If a running task is held its running job is not affected, but it will
not submit any more jobs (such as automatic :term:`retries <retry>`)
until released. The children of held tasks are not automatically held.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get what you mean here (children = graph children), but I don't think users will.

We can omit this (there is no reason to think that this might happen):

Suggested change
until released. The children of held tasks are not automatically held.
until released.

Copy link
Member Author

@hjoliver hjoliver Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed on graph children.

Less agreed on "there's no reason to think..." - I've had it several times from users who tried to "hold everything" by holding "all the tasks" - which doesn't hold everything because the children of any active tasks will carry on.

However, I'll take your suggestion.

@oliver-sanders
Copy link
Member

Could also do with a quick entry in the changes section, we'll post this on Discourse, etc to advertise the change in behavior.

@hjoliver
Copy link
Member Author

hjoliver commented Jan 8, 2025

Text review suggestions addressed.

TODO:

@wxtim
Copy link
Member

wxtim commented Jan 8, 2025

Fixes,

  • Animation
  • Including for spelling which is breaking the test

Does not add stuff to the changes section to avoid conflict.

hjoliver#3

@wxtim wxtim mentioned this pull request Jan 8, 2025
1 task
@MetRonnie
Copy link
Member

Superseded by #790

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants