diff options
| author | Nicholas Nethercote <n.nethercote@gmail.com> | 2024-11-18 15:43:13 +1100 |
|---|---|---|
| committer | Nicholas Nethercote <n.nethercote@gmail.com> | 2024-11-26 11:23:36 +1100 |
| commit | 7e704afc2d48df0f266ac592d0806c6770a3d08c (patch) | |
| tree | cb2f4cdf9beeccd26e07dc3cc057e7dfa5b988d6 /compiler/rustc_mir_dataflow/src/framework/mod.rs | |
| parent | 0066acf753ced0730cb4a2337ed083dd7e4d9a0d (diff) | |
| download | rust-7e704afc2d48df0f266ac592d0806c6770a3d08c.tar.gz rust-7e704afc2d48df0f266ac592d0806c6770a3d08c.zip | |
Add some useful comments.
Describing some things that took me a long time to understand.
Diffstat (limited to 'compiler/rustc_mir_dataflow/src/framework/mod.rs')
| -rw-r--r-- | compiler/rustc_mir_dataflow/src/framework/mod.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/compiler/rustc_mir_dataflow/src/framework/mod.rs b/compiler/rustc_mir_dataflow/src/framework/mod.rs index 7c3bcebcfe2..f9e7ba743fc 100644 --- a/compiler/rustc_mir_dataflow/src/framework/mod.rs +++ b/compiler/rustc_mir_dataflow/src/framework/mod.rs @@ -8,8 +8,9 @@ //! The `impls` module contains several examples of dataflow analyses. //! //! Then call `iterate_to_fixpoint` on your type that impls `Analysis` to get a `Results`. From -//! there, you can use a `ResultsCursor` to inspect the fixpoint solution to your dataflow problem, -//! or implement the `ResultsVisitor` interface and use `visit_results`. The following example uses +//! there, you can use a `ResultsCursor` to inspect the fixpoint solution to your dataflow problem +//! (good for inspecting a small number of locations), or implement the `ResultsVisitor` interface +//! and use `visit_results` (good for inspecting many or all locations). The following example uses //! the `ResultsCursor` approach. //! //! ```ignore (cross-crate-imports) |