document analyse

Author: lcnr

compiler/rustc_trait_selection/src/solve/inspect/analyse.rs

@@ -1,3 +1,13 @@
+/// An infrastructure to mechanically analyse proof trees.
+///
+/// It is unavoidable that this representation is somewhat
+/// lossy as it should hide quite a few semantically relevant things,
+/// e.g. canonicalization and the order of nested goals.
+///
+/// @lcnr: However, a lot of the weirdness here is not strictly necessary
+/// and could be improved in the future. This is mostly good enough for
+/// coherence right now and was annoying to implement, so I am leaving it
+/// as is until we start using it for something else.  
 use std::ops::ControlFlow;
 
 use rustc_infer::infer::InferCtxt;