about summary refs log tree commit diff
diff options
context:
space:
mode:
authorpierwill <pierwill@users.noreply.github.com>2020-06-30 15:16:18 -0700
committerpierwill <pierwill@users.noreply.github.com>2020-07-03 10:44:06 -0700
commit20caf634bd3c9783a7822e86811a7e77a88d378f (patch)
treedd2b40b1d117dfbb3bf941ac1e6ef5e996dbc232
parenta1528c432e45339d9b5602a19ac3571e2900d37b (diff)
downloadrust-20caf634bd3c9783a7822e86811a7e77a88d378f.tar.gz
rust-20caf634bd3c9783a7822e86811a7e77a88d378f.zip
Edit docs for rustc_data_structures::graph::scc
- Add newline to provide concise module summary
- Add wikipedia link
- Italicize O notation
-rw-r--r--src/librustc_data_structures/graph/scc/mod.rs10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/librustc_data_structures/graph/scc/mod.rs b/src/librustc_data_structures/graph/scc/mod.rs
index 57eaf56f268..2db8e466e11 100644
--- a/src/librustc_data_structures/graph/scc/mod.rs
+++ b/src/librustc_data_structures/graph/scc/mod.rs
@@ -1,7 +1,9 @@
-//! Routine to compute the strongly connected components (SCCs) of a
-//! graph, as well as the resulting DAG if each SCC is replaced with a
-//! node in the graph. This uses Tarjan's algorithm that completes in
-//! O(n) time.
+//! Routine to compute the strongly connected components (SCCs) of a graph.
+//!
+//! Also computes as the resulting DAG if each SCC is replaced with a
+//! node in the graph. This uses [Tarjan's algorithm](
+//! https://en.wikipedia.org/wiki/Tarjan%27s_strongly_connected_components_algorithm)
+//! that completes in *O(n)* time.
 
 use crate::fx::FxHashSet;
 use crate::graph::vec_graph::VecGraph;