From 06909f182151cf2332a14909e8b772ab4648854e Mon Sep 17 00:00:00 2001
From: Vincent Ambo <mail@tazj.in>
Date: Mon, 5 Sep 2022 01:30:58 +0300
Subject: fix(tvix/eval): fix doc comment syntax where applicable

As pointed out by grfn on cl/6091

Change-Id: I28308577b7cf99dffb4a4fd3cc8783eb9ab4d0d6
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6460
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
---
 tvix/eval/src/errors.rs | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'tvix/eval/src/errors.rs')

diff --git a/tvix/eval/src/errors.rs b/tvix/eval/src/errors.rs
index 5f1a24b54b..2b8ba8f963 100644
--- a/tvix/eval/src/errors.rs
+++ b/tvix/eval/src/errors.rs
@@ -20,37 +20,37 @@ pub enum ErrorKind {
         rhs: &'static str,
     },
 
-    // Resolving a user-supplied path literal failed in some way.
+    /// Resolving a user-supplied path literal failed in some way.
     PathResolution(String),
 
-    // Dynamic keys are not allowed in let.
+    /// Dynamic keys are not allowed in let.
     DynamicKeyInLet(rnix::SyntaxNode),
 
-    // Unknown variable in statically known scope.
+    /// Unknown variable in statically known scope.
     UnknownStaticVariable,
 
-    // Unknown variable in dynamic scope (with, rec, ...).
+    /// Unknown variable in dynamic scope (with, rec, ...).
     UnknownDynamicVariable(String),
 
-    // User is defining the same variable twice at the same depth.
+    /// User is defining the same variable twice at the same depth.
     VariableAlreadyDefined(String),
 
-    // Attempt to call something that is not callable.
+    /// Attempt to call something that is not callable.
     NotCallable,
 
-    // Infinite recursion encountered while forcing thunks.
+    /// Infinite recursion encountered while forcing thunks.
     InfiniteRecursion,
 
     ParseErrors(Vec<rnix::parser::ParseError>),
 
     AssertionFailed,
 
-    // These are user-generated errors through builtins.
+    /// These are user-generated errors through builtins.
     Throw(String),
     Abort(String),
 
-    // An error occured while forcing a thunk, and needs to be chained
-    // up.
+    /// An error occured while forcing a thunk, and needs to be
+    /// chained up.
     ThunkForce(Box<Error>),
 }
 
-- 
cgit 1.4.1