Fix code example in README #31
Open
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
aburkhalter512
commented
May 28, 2022
| @@ -0,0 +1,46 @@ | |||
| use teloc::*; | |||
Collaborator
Author
There was a problem hiding this comment.
Added this test to ensure that the code in the example compiles
Owner
There was a problem hiding this comment.
You can test readme examples using such hack (taken from teloxide):
#[cfg(all(feature = "nightly", doctest))]
#[cfg_attr(feature = "nightly", cfg_attr(feature = "nightly", doc = include_str!("../README.md")))]
enum ReadmeDocTests {}
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.
Fixes the code example in the README. The root of the problem was that the instance of the integer doesn't implement
DependencyCloneso replacing it with a reference fixes the problem. I additionally wrapped it in a struct to better represent actual usage (I don't expect raw integers to be added as instances as standard practice. Wrapping them in a "config" struct seems more likely)Fixes #28