Disallow warnings in doctests #330
Merged
Conversation
This file contains 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
metasim
commented
Nov 7, 2022
| /// ``` | ||
| /// ```text | ||
| /// Cloud optimized GeoTIFF generator | ||
| /// ``` | ||
| #[deprecated(note = "Please use `DriverManager::get_driver_by_name()` instead")] |
There was a problem hiding this comment.
FYI: This example is now available in DriverManager.
metasim
commented
Nov 7, 2022
| @@ -2,6 +2,7 @@ | |||
| #![crate_type = "lib"] | |||
| // Enable `doc_cfg` features when `docsrs` is defined by docs.rs config | |||
| #![cfg_attr(docsrs, feature(doc_cfg))] | |||
| #![doc(test(attr(deny(warnings), allow(dead_code, unused_variables))))] | |||
There was a problem hiding this comment.
This was stolen from tokio-rs.
lnicola
approved these changes
Nov 7, 2022
|
bors r+ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CHANGES.mdif knowledge of this change could be valuable to users.This helps us ensure the documentation abides by deprecations.