-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-libsRelevant to the library team, which will review and decide on the PR/issue.Relevant to the library team, which will review and decide on the PR/issue.
Description
Location
https://doc.rust-lang.org/std/macro.todo.html
Summary
The documentation of the todo!
macro currently does not mention at all that it also accepts optional format arguments, for example:
todo!("with {}", 1);
Other macros like unimplemented!
at least have the following sentence under "Panics":
Like
panic!
, this macro has a second form for displaying custom values.
So maybe it would be good to do the following?
- Update the "Panics" section to be similar to https://doc.rust-lang.org/std/macro.unimplemented.html#panics
- Extend / adjust example to also show usage of custom message
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-libsRelevant to the library team, which will review and decide on the PR/issue.Relevant to the library team, which will review and decide on the PR/issue.