docs

Author: acl-cqc

hugr-core/src/hugr/validate.rs

@@ -709,17 +709,11 @@ pub enum ValidationError<N: HugrNode> {
     /// (Multiple [`FuncDecl`](crate::ops::FuncDecl)s with the same signature are allowed)
     #[error("FuncDefn is exported under same name {link_name} as earlier node {:?}", children[0])]
     DuplicateLinkName {
-        /// The `link_name` of a `FuncDecl` or [`FuncDefn`]
+        /// The `link_name` of a `FuncDecl` or `FuncDefn`
         link_name: String,
         /// Two nodes using that `link_name`
         children: [N; 2],
     },
-    /// 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
     /// The children graph has invalid edges.
     #[error(
         "An operation {parent_optype} contains invalid edges between its children: {source}. In parent {parent}, edge from {from:?} port {from_port:?} to {to:?} port {to_port:?}",

hugr-model/src/v0/mod.rs

@@ -249,7 +249,7 @@ pub const CORE_META_DESCRIPTION: &str = "core.meta.description";
 pub const CORE_ENTRYPOINT: &str = "core.entrypoint";
 
 /// Metadata to tag the name of a function (typically human readable; not for linking),
-/// i.e. [crate::ops::FuncDefn::func_name]
+/// i.e. `hugr-core::ops::FuncDefn::func_name`
 ///
 /// - **Result:** `core.meta`   (ALAN?)
 pub const CORE_META_FUNCNAME: &str = "core.meta.func_name";

hugr-passes/src/dead_funcs.rs

@@ -137,6 +137,7 @@ impl<H: HugrMut<Node = Node>> ComposablePass<H> for RemoveDeadFuncsPass {
 /// * If any node in `entry_points` is not a [`FuncDefn`]
 ///
 /// [`Call`]: hugr_core::ops::OpType::Call
+/// [`FuncDefn`]: hugr_core::ops::OpType::FuncDefn
 /// [link_name]: hugr_core::ops::FuncDefn::link_name
 /// [`LoadFunction`]: hugr_core::ops::OpType::LoadFunction
 /// [`Module`]: hugr_core::ops::OpType::Module