Remove duplicate descriptions in API docs for triggers (PrefectHQ#4959)

ryoasu · web-flow · commit 61a6de5fd225 · 2021-09-13T09:16:34.000-05:00
* Remove duplicate descriptions in API docs for triggers

* Remove always_run in outline
diff --git a/docs/api/0.12.6/triggers.md b/docs/api/0.12.6/triggers.md
@@ -54,8 +54,6 @@ flow.run()
 <p class="methods">This task will run no matter what the upstream states are, as long as they are finished.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-manual-only'><p class="prefect-class">prefect.triggers.manual_only</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L90">[source]</a></span></div>
 <p class="methods">This task will never run automatically, because this trigger will always place the task in a Paused state. The only exception is if the "resume" keyword is found in the Prefect context, which happens automatically when a task starts in a Resume state.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
- | <div class='method-sig' id='prefect-triggers-all-finished'><p class="prefect-class">prefect.triggers.all_finished</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L75">[source]</a></span></div>
-<p class="methods">This task will run no matter what the upstream states are, as long as they are finished.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-all-successful'><p class="prefect-class">prefect.triggers.all_successful</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L106">[source]</a></span></div>
 <p class="methods">Runs if all upstream tasks were successful. Note that `SKIPPED` tasks are considered successes and `TRIGGER_FAILED` tasks are considered failures.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-all-failed'><p class="prefect-class">prefect.triggers.all_failed</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L122">[source]</a></span></div>
diff --git a/docs/api/0.13.19/triggers.md b/docs/api/0.13.19/triggers.md
@@ -54,8 +54,6 @@ flow.run()
 <p class="methods">This task will run no matter what the upstream states are, as long as they are finished.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-manual-only'><p class="prefect-class">prefect.triggers.manual_only</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L90">[source]</a></span></div>
 <p class="methods">This task will never run automatically, because this trigger will always place the task in a Paused state. The only exception is if the "resume" keyword is found in the Prefect context, which happens automatically when a task starts in a Resume state.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
- | <div class='method-sig' id='prefect-triggers-all-finished'><p class="prefect-class">prefect.triggers.all_finished</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L75">[source]</a></span></div>
-<p class="methods">This task will run no matter what the upstream states are, as long as they are finished.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-all-successful'><p class="prefect-class">prefect.triggers.all_successful</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L106">[source]</a></span></div>
 <p class="methods">Runs if all upstream tasks were successful. Note that `SKIPPED` tasks are considered successes and `TRIGGER_FAILED` tasks are considered failures.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-all-failed'><p class="prefect-class">prefect.triggers.all_failed</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L122">[source]</a></span></div>
diff --git a/docs/api/0.14.22/triggers.md b/docs/api/0.14.22/triggers.md
@@ -54,8 +54,6 @@ flow.run()
 <p class="methods">This task will run no matter what the upstream states are, as long as they are finished.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-manual-only'><p class="prefect-class">prefect.triggers.manual_only</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L90">[source]</a></span></div>
 <p class="methods">This task will never run automatically, because this trigger will always place the task in a Paused state. The only exception is if the "resume" keyword is found in the Prefect context, which happens automatically when a task starts in a Resume state.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
- | <div class='method-sig' id='prefect-triggers-all-finished'><p class="prefect-class">prefect.triggers.all_finished</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L75">[source]</a></span></div>
-<p class="methods">This task will run no matter what the upstream states are, as long as they are finished.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-all-successful'><p class="prefect-class">prefect.triggers.all_successful</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L106">[source]</a></span></div>
 <p class="methods">Runs if all upstream tasks were successful. Note that `SKIPPED` tasks are considered successes and `TRIGGER_FAILED` tasks are considered failures.<br><br>**Args**:     <ul class="args"><li class="args">`upstream_states (dict[Edge, State])`: the set of all upstream states</li></ul></p>|
  | <div class='method-sig' id='prefect-triggers-all-failed'><p class="prefect-class">prefect.triggers.all_failed</p>(upstream_states)<span class="source"><a href="https://github.com/PrefectHQ/prefect/blob/master/src/prefect/triggers.py#L122">[source]</a></span></div>
diff --git a/docs/outline.toml b/docs/outline.toml
@@ -8,7 +8,6 @@ module = "prefect.triggers"
 functions = [
     "all_finished",
     "manual_only",
-    "always_run",
     "all_successful",
     "all_failed",
     "any_successful",
