mirror of
https://github.com/rust-lang/rust
synced 2024-10-21 16:03:40 +00:00
Adjust documentation for compatibility with 2021
This also adjusts the lint docs generation to accept (and ignore) an allow attribute, rather than expecting the documentation to be immediately followed by the lint name.
This commit is contained in:
parent
f338900826
commit
3b89679671
|
@ -13,7 +13,7 @@
|
|||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```rust
|
||||
/// ```rust,edition2018
|
||||
/// # #![allow(unused)]
|
||||
/// [1, 2, 3].into_iter().for_each(|n| { *n; });
|
||||
/// ```
|
||||
|
|
|
@ -1686,7 +1686,7 @@ fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'tcx>) {
|
|||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```rust
|
||||
/// ```rust,edition2018
|
||||
/// let x = 123;
|
||||
/// match x {
|
||||
/// 0...100 => {}
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```rust,no_run
|
||||
/// ```rust,no_run,edition2018
|
||||
/// panic!("{}");
|
||||
/// panic!(123);
|
||||
/// ```
|
||||
|
|
|
@ -1584,7 +1584,7 @@
|
|||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```rust
|
||||
/// ```rust,edition2018
|
||||
/// trait Trait { }
|
||||
///
|
||||
/// fn takes_trait_object(_: Box<Trait>) {
|
||||
|
@ -3313,7 +3313,7 @@
|
|||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```rust,compile_fail
|
||||
/// ```rust,edition2018,compile_fail
|
||||
/// #![deny(rust_2021_prefixes_incompatible_syntax)]
|
||||
///
|
||||
/// macro_rules! m {
|
||||
|
@ -3333,6 +3333,8 @@
|
|||
///
|
||||
/// This lint suggests to add whitespace between the `z` and `"hey"` tokens
|
||||
/// to keep them separated in Rust 2021.
|
||||
// Allow this lint -- rustdoc doesn't yet support threading edition into this lint's parser.
|
||||
#[allow(rustdoc::invalid_rust_codeblocks)]
|
||||
pub RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
|
||||
Allow,
|
||||
"identifiers that will be parsed as a prefix in Rust 2021",
|
||||
|
|
|
@ -257,7 +257,8 @@ pub struct ScopeTree {
|
|||
/// ```
|
||||
///
|
||||
/// With the HIR tree (calls numbered for expository purposes)
|
||||
/// ```
|
||||
///
|
||||
/// ```text
|
||||
/// Call#0(foo, [Call#1(f), Yield(y), Call#2(bar, Call#3(g))])
|
||||
/// ```
|
||||
///
|
||||
|
|
|
@ -149,6 +149,10 @@ fn lints_from_file(&self, path: &Path) -> Result<Vec<Lint>, Box<dyn Error>> {
|
|||
} else if line.starts_with("// ") {
|
||||
// Ignore comments.
|
||||
continue;
|
||||
} else if line.starts_with("#[allow") {
|
||||
// Ignore allow of lints (useful for
|
||||
// invalid_rust_codeblocks).
|
||||
continue;
|
||||
} else {
|
||||
let name = lint_name(line).map_err(|e| {
|
||||
format!(
|
||||
|
|
Loading…
Reference in a new issue