Skip to content

docs: fix documentation drift — schedule frequency table missing plain weekly#1165

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-schedule-frequency-table-missing-weekly-177f7f31edd3f2cd
Draft

docs: fix documentation drift — schedule frequency table missing plain weekly#1165
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-schedule-frequency-table-missing-weekly-177f7f31edd3f2cd

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
Schedule frequency table weekly (plain, without on <day>) is missing from the frequency reference table prompts/create-ado-agentic-workflow.md

Details

The frequency table in Step 3 of prompts/create-ado-agentic-workflow.md listed every schedule variant except plain weekly:

Expression Meaning
daily Once/day, time scattered
daily around 14:00 ...
weekly on monday Every Monday, scattered time
weekly on friday around 17:00 Friday ~5 PM

Why this matters: schedule: weekly (without specifying a day) is fully supported by the compiler. In src/fuzzy_schedule.rs, parse_weekly_schedule() explicitly handles the empty-token case:

if tokens.is_empty() {
    return Ok(FuzzySchedule::Weekly {
        day: None,
        constraint: TimeConstraint::None,
    });
}

It is also documented in docs/schedule-syntax.md (line 30: schedule: weekly # Any day, scattered time).

Agents consulting prompts/create-ado-agentic-workflow.md as the authoritative authoring guide would not know they can use schedule: weekly for a once-per-week run on any scattered day.

Applied Fixes

  • Added | \weekly` | Any day of the week, time scattered |to the Step 3 frequency table inprompts/create-ado-agentic-workflow.md, between the daily betweenrow andweekly on monday`

This pull request was created by the automated documentation freshness check.

Generated by Documentation Freshness Check · 1.9K AIC · ⌖ 18.4 AIC · ⊞ 36.2K ·

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants