docs: clarify df.status() takes instance_id, not label (#167)#267
Open
crprashant wants to merge 1 commit into
Open
docs: clarify df.status() takes instance_id, not label (#167)#267crprashant wants to merge 1 commit into
crprashant wants to merge 1 commit into
Conversation
…crosoft#167) State explicitly that df.status() and df.result() accept an instance_id from df.start(), not a label, and document the supported label -> instance_id resolution pattern via df.list_instances(). Also fix the df.status() example casing to the actual lowercase status values. Closes microsoft#167
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documentation-only clarification for
df.status()(anddf.result()):instance_idreturned bydf.start(), not a label. Passing a label returnsNULL.instance_idresolution pattern viadf.list_instances().df.status()example casing indocs/api-reference.md: it claimed'Running'/'Completed', but the function readsdf.instances.statusdirectly and returns the lowercase values'pending' | 'running' | 'completed' | 'failed' | 'cancelled'.Files touched:
docs/api-reference.md,USER_GUIDE.md(Quick Status Check + quick-reference table).Why
Closes #167. This is PR 1 of the agreed, incremental monitoring-functions plan discussed on #167 — the docs-only fix first, with the listing/pagination/label-filter work (touching #87 and #146) to follow in separate small PRs.
Scope
Docs only — no code, schema, or behavior changes. No first-class label filter is added here; that is a later PR in the plan.
cc @pinodeca @tjgreen42 @AbeOmor