diff --git a/README.md b/README.md index cc6a0d9..c17da1b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![CI](https://github.com/lambda-fairy/if_chain/actions/workflows/ci.yml/badge.svg)](https://github.com/lambda-fairy/if_chain/actions/workflows/ci.yml) [![Cargo](https://img.shields.io/crates/v/if_chain.svg)](https://crates.io/crates/if_chain) +**If you're using Rust 1.62 or newer, check out [`if let` chains](https://github.com/rust-lang/rfcs/blob/master/text/2497-if-let-chains.md) instead. This crate is still available for earlier versions of Rust.** + This crate provides a single macro called `if_chain!`. `if_chain!` lets you write long chains of nested `if` and `if let` statements without the associated rightward drift. It also supports multiple patterns (e.g. `if let Foo(a) | Bar(a) = b`) in places where Rust would normally not allow them. diff --git a/src/lib.rs b/src/lib.rs index 687935a..a0b786d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,8 @@ //! This crate provides a single macro called `if_chain!`. //! +//! **If you're using Rust 1.62 or newer, check out [`if let` chains][rfc] instead. +//! This crate is still available for earlier versions of Rust.** +//! //! `if_chain!` lets you write long chains of nested `if` and `if let` //! statements without the associated rightward drift. It also supports multiple //! patterns (e.g. `if let Foo(a) | Bar(a) = b`) in places where Rust would @@ -7,6 +10,7 @@ //! //! See the associated [blog post] for the background behind this crate. //! +//! [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/2497-if-let-chains.md //! [blog post]: https://lambda.xyz/blog/if-chain //! //! # Note about recursion limits