doclinks

Author: acl-cqc

hugr-core/src/builder/dataflow.rs

@@ -152,7 +152,7 @@ impl<B, T> DFGWrapper<B, T> {
 pub type FunctionBuilder<B> = DFGWrapper<B, BuildHandle<FuncID<true>>>;
 
 impl FunctionBuilder<Hugr> {
-    /// Initialize a builder for a [FuncDefn]-rooted HUGR; the function will be private.
+    /// Initialize a builder for a [`FuncDefn`](ops::FuncDefn)-rooted HUGR; the function will be private.
     /// (See also [Self::new_pub], [Self::new_link_name].)
     ///
     /// # Errors

hugr-core/src/hugr/validate.rs

@@ -709,13 +709,17 @@ pub enum ValidationError<N: HugrNode> {
     /// Multiple nodes were exported using the same name from a [Module](super::Module)
     #[error("FuncDefn is exported under same name {link_name} as earlier node {:?}", children[0])]
     DuplicateExternalNames {
-        /// The link_name of a [FuncDecl] or [FuncDefn](super::FuncDefn)
+        /// The link_name of a [`FuncDecl`](crate::ops::FuncDecl) or [`FuncDefn`]
         link_name: String,
         /// Two nodes node exported under that name
         children: [N; 2],
     },
-    /// A [FuncDecl], or `FuncDefn` with a [link_name](super::FuncDefn::link_name),
-    /// was neither root nor child of a [Module] root
+    /// A [`FuncDecl`], or [`FuncDefn`] with a [link_name],
+    /// was neither root nor child of a [`Module`] root
+    ///
+    /// [`FuncDecl`]: crate::ops::FuncDecl
+    /// [link_name]: FuncDefn::link_name
+    /// [`Module`]: crate::ops::Module
     #[error("Node {node} has a link_name but is neither root nor child of Module root")]
     LinkNameNotAtTopLevel {
         // The node exporting/importing the name

hugr-passes/src/dead_funcs.rs

@@ -91,8 +91,9 @@ impl RemoveDeadFuncsPass {
         self
     }
 
-    /// Sets whether the exported [FuncDefn](hugr_core::ops::FuncDefn) children of a
-    /// [Module](hugr_core::ops::Module) are included as entry points (yes by default)
+    /// When the [HugrView::entrypoint] is a [Module](hugr_core::ops::Module),
+    /// sets whether the exported [FuncDefn](hugr_core::ops::FuncDefn) children are
+    /// included as entry points for reachability analysis. (Yes by default.)
     pub fn include_module_exports(mut self, include: bool) -> Self {
         self.include_exports = include;
         self
@@ -136,9 +137,13 @@ impl<H: HugrMut<Node = Node>> ComposablePass<H> for RemoveDeadFuncsPass {
 /// Deletes from the Hugr any functions that are not used by either [`Call`] or
 /// [`LoadFunction`] nodes in reachable parts.
 ///
-/// For [`Module`]-rooted Hugrs, all top-level functions with [FuncDefn::link_name] set,
+/// For [`Module`]-rooted Hugrs, all top-level functions with [link_name] set,
 /// will be used as entry points.
 ///
+/// [`Call`]: hugr_core::ops::OpType::Call
+/// [link_name]: hugr_core::ops::FuncDefn::link_name
+/// [`LoadFunction`]: hugr_core::ops::OpType::LoadFunction
+/// [`Module`]: hugr_core::ops::OpType::Module
 pub fn remove_dead_funcs(
     h: &mut impl HugrMut<Node = Node>,
 ) -> Result<(), ValidatePassError<Node, RemoveDeadFuncsError>> {