Change missing impl assist to use todo!() instead of unimplemented() #3935
Conversation
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
todo!() "Indicates unfinished code" (https://doc.rust-lang.org/std/macro.todo.html) Rust documentation provides further clarification: > The difference between unimplemented! and todo! is that while todo! > conveys an intent of implementing the functionality later and the > message is "not yet implemented", unimplemented! makes no such claims. todo!() seems more appropriate for assists that insert missing impls.
cjhopman
commented
Apr 10, 2020
|
|
||
| fn check_todo(path: &Path, text: &str) { | ||
| if path.ends_with("tests/cli.rs") { | ||
| let whitelist = &[ |
Contributor
Author
There was a problem hiding this comment.
Not particularly happy about this approach, but this isn't a particularly sophisticated check that would allow more fine grained configuration.
Might be reasonable to extend this to detect some marker in the file that allows more fine-grained ignoring, but idk.
Any suggestions?
Contributor
There was a problem hiding this comment.
I think such whitelisting is the optimal solution, given the scale of the problem actually!
Contributor
Author
|
I mentioned this preference (todo over unimplemented) in #3904 and figured it'd be rather trivial to change. |
Contributor
|
bors r+ Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
todo!() "Indicates unfinished code" (https://doc.rust-lang.org/std/macro.todo.html)
Rust documentation provides further clarification:
todo!() seems more appropriate for assists that insert missing impls.