docs: fix misleading require-approval timeout-minutes comment in create prompt#1475
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…te prompt The comment 'Optional: 24h default' implied that 1440 minutes was the default value for timeout-minutes, when in fact the field defaults to None (inheriting the pipeline/job timeout). Updated to clarify that 1440 is an example value and that omitting the field uses the pipeline default — consistent with docs/safe-outputs.md which already says 'omit → pipeline default'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Agent Documentation Update
Findings
timeout-minutes: 1440 # Optional: 24h defaultimplies 1440 minutes (24h) is the default value, but the field actually defaults toNone(inheriting the pipeline/job timeout). This could cause agents using the prompt to believe they're relying on a 24h default when they omit the field.prompts/create-ado-agentic-workflow.mdApplied Fixes
timeout-minutescomment in therequire-approvalexample from# Optional: 24h defaultto# Optional: e.g. 1440 for 24h; omit → pipeline/job timeout applies— consistent withdocs/safe-outputs.mdwhich already saysomit → pipeline default.Notes
Verified against
src/compile/types.rsApprovalConfig.timeout_minutes:The field defaults to
None. Thedocs/safe-outputs.mdreference page at line 67 correctly documents this asomit → pipeline default, so this PR brings the create prompt into alignment.Created by the agent-documentation maintainer workflow.