docs: fix documentation drift — schedule frequency table missing plain weekly#1165
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
The frequency table in prompts/create-ado-agentic-workflow.md omitted
the plain `weekly` schedule (without an 'on <day>' modifier), which is
fully supported by the compiler (parse_weekly_schedule returns
FuzzySchedule::Weekly { day: None } when no tokens follow) and is
documented in docs/schedule-syntax.md.
Agents consulting this table would not know to use `schedule: weekly`
when they want a once-per-week run on any day.
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.
Documentation Freshness Audit
This audit found the following inconsistency between code and documentation:
Findings
weekly(plain, withouton <day>) is missing from the frequency reference tableprompts/create-ado-agentic-workflow.mdDetails
The frequency table in Step 3 of
prompts/create-ado-agentic-workflow.mdlisted every schedule variant except plainweekly:dailydaily around 14:00weekly on mondayweekly on friday around 17:00Why this matters:
schedule: weekly(without specifying a day) is fully supported by the compiler. Insrc/fuzzy_schedule.rs,parse_weekly_schedule()explicitly handles the empty-token case:It is also documented in
docs/schedule-syntax.md(line 30:schedule: weekly # Any day, scattered time).Agents consulting
prompts/create-ado-agentic-workflow.mdas the authoritative authoring guide would not know they can useschedule: weeklyfor a once-per-week run on any scattered day.Applied Fixes
| \weekly` | Any day of the week, time scattered |to the Step 3 frequency table inprompts/create-ado-agentic-workflow.md, between thedaily betweenrow andweekly on monday`This pull request was created by the automated documentation freshness check.