C0008 todo-macros¶
Rule: No todo!() or unimplemented!() outside tests.
| Code | C0008 (stable, never reused) |
| Id | todo-macros |
| Category | code |
| Source | spirit_level |
| Fix | by hand |
Level per tier¶
| Tier | Level | Reason |
|---|---|---|
| small | warn |
no stop-gaps: a todo!() is a panic waiting in shipped code |
| small-workspace | warn |
no stop-gaps: a todo!() is a panic waiting in shipped code |
| medium | warn |
no stop-gaps: a todo!() is a panic waiting in shipped code |
| big | deny |
no stop-gaps: a todo!() is a panic waiting in shipped code |
| ai | deny |
todo!() and unimplemented!() are stop-gaps that compile |
| embedded | off | |
| ui | off | |
| egui | off | |
| units-strict | off | |
| units-paranoid | off |
Why¶
todo!() and unimplemented!() compile and then panic at run time: they are a promise that the design will be finished later. Under the no-stop-gaps rule a deferred design is a defect; planned work is an entry in FEATURES.md, not a panic waiting in shipped code. Test code is not checked. (Comment markers such as TODO and FIXME are checked by the prose lints.)
How to fix¶
Write the real implementation, or return an error that names what is not supported.
Configure¶
Allow one finding in the code with // spirit-level: allow(todo-macros) <reason> (waivers); the code works there too, as in [lints.C0008].