Skip to main content

rl_lang/docs/entries/stdlib/debug/
todo.rs

1use crate::docs::entry::FnEntry;
2
3pub static TODO: FnEntry = FnEntry {
4    signature: "todo(msg?)",
5    description: "marks unfinished code; errors with \"not yet implemented\" so incomplete functions fail loudly instead of silently returning null",
6    example: r#"
7get std::debug::todo
8
9fn upcoming() {
10    todo("implement retry logic")
11}"#,
12    expected_output: None,
13    returns: "never returns",
14    errors: Some("always raises a runtime error"),
15    see_also: &["panic", "unreachable"],
16    since: Some("v0.1.5"),
17};