docs: Fix documentation of ValidationError::ConstTypeError (#1227)

CQCL · Jun 26, 2024 · 70e0b87 · 70e0b87
1 parent c05edd3
commit 70e0b87
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/hugr-core/src/hugr/validate.rs b/hugr-core/src/hugr/validate.rs
@@ -760,13 +760,17 @@ pub enum ValidationError {
     /// Error in a node signature
     #[error("Error in signature of node {node:?}: {cause}")]
     SignatureError { node: Node, cause: SignatureError },
-    /// Error in a [CustomOp] serialized as an [Opaque]
+    /// Error in a [CustomOp] serialized as an [Opaque].
     ///
     /// [CustomOp]: crate::ops::CustomOp
     /// [Opaque]: crate::ops::CustomOp::Opaque
     #[error(transparent)]
     CustomOpError(#[from] CustomOpError),
-    /// TODO
+    /// A [Const] contained a [Value] of unexpected [Type].
+    ///
+    /// [Const]: crate::ops::Const
+    /// [Value]: crate::ops::Value
+    /// [Type]: crate::types::Type
     #[error(transparent)]
     ConstTypeError(#[from] ConstTypeError),
 }