Skip to content

Commit 68d876d

Browse files
committed
Clarify ignore status is manual, not automatic transition
- Updated state transition diagram to show only automatic transitions - Added note that ignore is manually set and skipped by populate/refresh - reset() can move ignore jobs back to pending
1 parent 4637708 commit 68d876d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/src/design/autopopulate-2.0-spec.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -134,31 +134,31 @@ FilteredImage.jobs.refresh() # Refresh job queue
134134
| `reserved` | Job is currently being processed by a worker |
135135
| `success` | Job completed successfully |
136136
| `error` | Job failed with an error |
137-
| `ignore` | Job should be skipped (manually set) |
137+
| `ignore` | Job should be skipped (manually set, not part of automatic transitions) |
138138

139139
### Status Transitions
140140

141+
Automatic transitions during `populate()`:
142+
141143
```
142-
┌─────────────────────────────────────┐
143-
│ │
144-
▼ │
145-
┌─────────┐ ┌──────────┐ ┌───────────┐ ┌────────┴──┐
144+
┌─────────┐ ┌──────────┐ ┌───────────┐ ┌───────────┐
146145
│ (none) │───▶│ pending │───▶│ reserved │───▶│ success │
147146
└─────────┘ └──────────┘ └───────────┘ └───────────┘
148-
│ │ │
149-
│ │ │
150-
│ ▼ ▼
151-
│ ┌──────────┐ ┌───────────┐
152-
└────────▶│ ignore │ │ error │───┐
153-
└──────────┘ └───────────┘ │
154-
▲ │ │
155-
│ ▼ │
156-
│ ┌──────────┐ │
157-
└──────────│ pending │◀───┘
158-
└──────────┘
159-
(after reset)
147+
refresh() reserve() complete()
148+
149+
│ error()
150+
151+
┌───────────┐ ┌──────────┐
152+
│ error │───▶│ pending │
153+
└───────────┘ └──────────┘
154+
reset()
160155
```
161156

157+
**Manual status control:**
158+
- `ignore` is set manually via `jobs.ignore(key)` and is not part of automatic transitions
159+
- Jobs with `status='ignore'` are skipped by `populate()` and `refresh()`
160+
- Use `jobs.reset()` to move `ignore` jobs back to `pending`
161+
162162
## API Design
163163

164164
### JobsTable Class

0 commit comments

Comments
 (0)