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

optional outputs: better document how family triggers work with optional outputs #677

Open
oliver-sanders opened this issue Dec 13, 2023 · 0 comments
Labels
content Addition or modification of documentation
Milestone

Comments

@oliver-sanders
Copy link
Member

Users often struggle when optional outputs and families meet.

We should clarify what familiy-triggers (e.g. :succeed-any) mean and give an example or two.

Here's a valid example of usage:

[scheduling]
    [[graph]]
        R1 = """
            # don't bother running tasks 2&3 unless task 1 succeeded
            task1? => task2? & task3?

            # only run fin if all the tasks succeeded
            FAM:succeed-all? => fin

            # run something_worked if any of the tasks succeeded
            FAM:succeed-any? => something_worked
        """

[runtime]
    [[task1]]
        inherit = FAM
    [[task2]]
        inherit = FAM
    [[task3]]
        inherit = FAM
    [[FAM]]
    [[fin, something_worked]]
@oliver-sanders oliver-sanders added the content Addition or modification of documentation label Dec 13, 2023
@oliver-sanders oliver-sanders added this to the pending milestone Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation
Projects
None yet
Development

No branches or pull requests

1 participant