docs: correct update-task checkbox instruction - #113
Merged
Conversation
The command doc told the agent to tick checkboxes via `vault-cli task update`, which cannot tick a specific box — it recomputes the derived status from checkbox counts (`statusFromProgress` in pkg/ops/update.go). Corrected to: direct body edit of the `- [ ]` line, then `vault-cli task update` to sync status. Frontmatter is still never edited directly.
![ben-s-pull-request-reviewer[bot]](https://avatars.githubusercontent.com/u/1193284?s=60&v=4){kind=small}
There was a problem hiding this comment.
{
"verdict": "approve",
"summary": "Docs-only PR correcting checkbox-ticking instructions in commands/update-task.md. The change accurately reflects that vault-cli task update recomputes derived status from checkbox counts via statusFromProgress in pkg/ops/update.go, and cannot tick individual checkboxes. CHANGELOG.md entry is present under Unreleased. Version alignment verified across plugin manifests.",
"comments": [],
"concerns_addressed": [
"correctness: instruction correction in commands/update-task.md:26 — verified accurate; the CLI recomputes status from checkbox counts via statusFromProgress in pkg/ops/update.go:129, not from individual checkbox edits"
]
}
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.
Found as a pre-existing uncommitted change in the shared checkout during session close. It is a correct fix, so it is landed here rather than discarded.
commands/update-task.mdinstructed the agent to tick checkboxes viavault-cli task update. That command cannot tick a specific checkbox — it recomputes the derived status from checkbox counts (statusFromProgress,pkg/ops/update.go). Following the doc literally leaves boxes unticked.Corrected to: direct edit of the
- [ ]body line, thenvault-cli task updateto sync status. Frontmatter is still never edited directly — that part of the original instruction was right and is preserved.Docs only, no code change.