Commit bb26bf3
docsy(v2): document the two narrative gaps left by four API regens
Closes the narrative half of the accumulated api-surface-delta backlog:
docs#1262, #1373, #1424 (DOC-1362) and #1457 (DOC-1447). Four regens, two
gaps.
Enumerating them was most of the work, because the version churn hides the
signal: #1457 alone is 309 files, of which 307 of the 366 added lines are
`version:` frontmatter bumps. Stripping those leaves very little, and most of
what remains was already covered.
## flyte get devbox (new in 2.6.2, DOC-1447)
Verified new rather than reworded: present at released tag v2.6.2
(cli/_get.py:864-895), zero occurrences at v2.6.1. The devbox page taught
start, stop and delete but had no way to answer "did it come up?", which is
the question a reader has at exactly that point in the page. Added as its own
section between starting and configuring, with --no-probes and the
`-of json-raw` form.
## Fetching a report after the run (DOC-1362)
reports.md covered writing a report from inside a task and said nothing about
reading one afterwards. That is a different reader task -- pull a finished
report into a notebook or a CI job -- and it was uncovered.
Documents Run.get_report(), the attempt argument, and the .aio variant. Also
covers the root-action distinction, which is the part most likely to bite:
Run.get_report() returns the ROOT action's report, so a run whose tasks call
other tasks needs Action.get_report() for a nested one. The SDK's own docstring
was amended to redirect readers there, which is the signal that flagged this
delta as material in the first place.
All three signatures verified against v2.6.2 rather than inferred:
Run.get(name), Action.get(run_name=, name=), Run.get_report(attempt=) with a
real .aio attribute.
## What was already covered, recorded so it is not redone
- Artifacts (#1373/#1424's headline delta, 7 new reference pages): shipped
yesterday as the user-guide artifacts section, docs#1454.
- Default pool/queue deletability (#1457): queues.md already documents the new
semantics including the run.default_queue guard.
- TaskTemplate and DeployedAppEnvironment (#1262): already referenced in
how-task-deployment-works.md and how-app-deployment-works.md.
- AsyncFunctionTaskTemplate (#1262): deliberately not documented. Its own
docstring says it is "automatically created when an asynchronous function is
decorated with the task decorator" -- users never write it, so zero narrative
mentions is correct, not a gap.
Co-Authored-By: docsy <docsy@union.ai>
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>1 parent 3ad1d14 commit bb26bf3
2 files changed
Lines changed: 59 additions & 0 deletions
Lines changed: 22 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
87 | 109 | | |
88 | 110 | | |
89 | 111 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
187 | 187 | | |
188 | 188 | | |
189 | 189 | | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
0 commit comments