From e7f61fc9016ff12bd0295d2923850a750bbe9ef7 Mon Sep 17 00:00:00 2001 From: Alan Lawrence Date: Tue, 22 Oct 2024 16:10:27 +0100 Subject: [PATCH] move docs --- hugr-passes/src/dataflow/datalog.rs | 3 +-- hugr-passes/src/dataflow/results.rs | 3 ++- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/hugr-passes/src/dataflow/datalog.rs b/hugr-passes/src/dataflow/datalog.rs index b8b7f18bf..0d4b6be25 100644 --- a/hugr-passes/src/dataflow/datalog.rs +++ b/hugr-passes/src/dataflow/datalog.rs @@ -15,8 +15,7 @@ type PV = PartialValue; /// Basic structure for performing an analysis. Usage: /// 1. Get a new instance via [Self::default()] /// 2. (Optionally / for tests) zero or more [Self::prepopulate_wire] with initial values -/// 3. Call [Self::run] to produce [AnalysisResults] which can be inspected via -/// [read_out_wire](AnalysisResults::read_out_wire) +/// 3. Call [Self::run] to produce [AnalysisResults] pub struct Machine(Vec<(Node, IncomingPort, PartialValue)>); /// derived-Default requires the context to be Defaultable, which is unnecessary diff --git a/hugr-passes/src/dataflow/results.rs b/hugr-passes/src/dataflow/results.rs index 0be8072b0..f457ef68c 100644 --- a/hugr-passes/src/dataflow/results.rs +++ b/hugr-passes/src/dataflow/results.rs @@ -4,7 +4,8 @@ use hugr_core::{ops::Value, types::ConstTypeError, HugrView, IncomingPort, Node, use super::{AbstractValue, PartialValue}; -/// Results of a dataflow analysis, packaged with context for easy inspection +/// Results of a dataflow analysis, packaged with the Hugr for easy inspection. +/// Methods allow inspection, specifically [read_out_wire](Self::read_out_wire). pub struct AnalysisResults { pub(super) hugr: H, pub(super) in_wire_value: Vec<(Node, IncomingPort, PartialValue)>,