Skip to content

Commit 609a202

Browse files
committed
Documentation fixes
1 parent ad7e623 commit 609a202

File tree

1 file changed

+7
-8
lines changed
  • compiler/rustc_data_structures/src/graph/scc

1 file changed

+7
-8
lines changed

compiler/rustc_data_structures/src/graph/scc/mod.rs

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -250,17 +250,17 @@ enum NodeState<N, S, A> {
250250
NotVisited,
251251

252252
/// This node is currently being walked as part of our DFS. It is on
253-
/// the stack at the depth `depth` and the heaviest node on the way
254-
/// there is `max_weigth_on_path`.
253+
/// the stack at the depth `depth` and its current annotation is
254+
/// `annotation`.
255255
///
256256
/// After SCC construction is complete, this state ought to be
257257
/// impossible.
258258
BeingVisited { depth: usize, annotation: A },
259259

260260
/// Indicates that this node is a member of the given cycle where
261-
/// the weight of the heaviest node is `cycle_max_weight`.
262-
/// Note that an SCC can have several cycles, so the max
263-
/// weight of an SCC is the max weight of all its cycles.
261+
/// the merged annotation is `annotation`.
262+
/// Note that an SCC can have several cycles, so its final annotation
263+
/// is the merged value of all its member annotations.
264264
InCycle { scc_index: S, annotation: A },
265265

266266
/// Indicates that this node is a member of whatever cycle
@@ -304,9 +304,8 @@ where
304304
/// D' (i.e., D' < D), we know that N, N', and all nodes in
305305
/// between them on the stack are part of an SCC.
306306
///
307-
/// Additionally, we keep track of a representative of the SCC with the highest
308-
/// reachable weight for all SCCs, for some arbitrary ordering function that assigns
309-
/// a weight to nodes.
307+
/// Additionally, we keep track of a representative annotation of the
308+
/// SCC.
310309
///
311310
/// [wikipedia]: https://bit.ly/2EZIx84
312311
fn construct(graph: &'c G, to_annotation: F) -> Sccs<G::Node, S, A> {

0 commit comments

Comments
 (0)