diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2023-01-03 17:12:10 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-03 17:12:10 +0100 |
| commit | da07053ee1e80ef44707bd4dd25630d9dd8180dc (patch) | |
| tree | 55a73ce832e69b6682a7698fee328ef90545286d | |
| parent | 258a0fb89eba4ffb1d492401ce7176311ded8927 (diff) | |
| parent | 5a7e8f8b7970b21c40d28013800a6d4ae0c8374a (diff) | |
| download | rust-da07053ee1e80ef44707bd4dd25630d9dd8180dc.tar.gz rust-da07053ee1e80ef44707bd4dd25630d9dd8180dc.zip | |
Rollup merge of #105681 - tshepang:doc-mir-visit, r=Nilstrieb
some fixes/improvements to mir::visit module
| -rw-r--r-- | compiler/rustc_middle/src/mir/visit.rs | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/compiler/rustc_middle/src/mir/visit.rs b/compiler/rustc_middle/src/mir/visit.rs index 2ee3f551529..1a264d2d5af 100644 --- a/compiler/rustc_middle/src/mir/visit.rs +++ b/compiler/rustc_middle/src/mir/visit.rs @@ -3,15 +3,15 @@ //! ## Overview //! //! There are two visitors, one for immutable and one for mutable references, -//! but both are generated by the following macro. The code is written according -//! to the following conventions: +//! but both are generated by the `make_mir_visitor` macro. +//! The code is written according to the following conventions: //! //! - introduce a `visit_foo` and a `super_foo` method for every MIR type //! - `visit_foo`, by default, calls `super_foo` //! - `super_foo`, by default, destructures the `foo` and calls `visit_foo` //! -//! This allows you as a user to override `visit_foo` for types are -//! interested in, and invoke (within that method) call +//! This allows you to override `visit_foo` for types you are +//! interested in, and invoke (within that method call) //! `self.super_foo` to get the default behavior. Just as in an OO //! language, you should never call `super` methods ordinarily except //! in that circumstance. |
