about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-09-21T21·57+0300
committerflokli <flokli@flokli.de>2023-09-22T09·14+0000
commit731996fbfe5947190443ed70385632a7f9e07e06 (patch)
tree7619b0f63f6781ed9cdf651ab6cc2a8acfcf3685
parent37a348b4fae16b2b1c5ec12deaa085a049833d7f (diff)
docs(tvix/eval): fix some broken docstr references r/6624
There's some more left, but they've been renamed/refactored out of
sight.

Change-Id: I41579dedc74342b4c5f8cb39d2995b5b0c90b0f4
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9372
Tested-by: BuildkiteCI
Reviewed-by: Connor Brewster <cbrewster@hey.com>
Autosubmit: flokli <flokli@flokli.de>
-rw-r--r--tvix/eval/src/chunk.rs4
-rw-r--r--tvix/eval/src/compiler/mod.rs2
-rw-r--r--tvix/eval/src/value/builtin.rs5
-rw-r--r--tvix/eval/src/value/function.rs6
-rw-r--r--tvix/eval/src/vm/mod.rs4
5 files changed, 11 insertions, 10 deletions
diff --git a/tvix/eval/src/chunk.rs b/tvix/eval/src/chunk.rs
index 9d35b30c64..b6fc6be5b9 100644
--- a/tvix/eval/src/chunk.rs
+++ b/tvix/eval/src/chunk.rs
@@ -8,7 +8,7 @@ use crate::SourceCode;
 /// Represents a source location from which one or more operations
 /// were compiled.
 ///
-/// The span itself is an index into a [codemap::Codemap], and the
+/// The span itself is an index into a [codemap::CodeMap], and the
 /// structure tracks the number of operations that were yielded from
 /// the same span.
 ///
@@ -18,7 +18,7 @@ use crate::SourceCode;
 /// interesting errors.
 #[derive(Clone, Debug, PartialEq)]
 struct SourceSpan {
-    /// Span into the [codemap::Codemap].
+    /// Span into the [codemap::CodeMap].
     span: codemap::Span,
 
     /// Index of the first operation covered by this span.
diff --git a/tvix/eval/src/compiler/mod.rs b/tvix/eval/src/compiler/mod.rs
index b7b9192571..3ab0e4d933 100644
--- a/tvix/eval/src/compiler/mod.rs
+++ b/tvix/eval/src/compiler/mod.rs
@@ -350,7 +350,7 @@ impl Compiler<'_> {
     /// warnings in that expression.
     ///
     /// A warning about the that code being dead is assumed to already be
-    /// emitted by the caller of [compile_dead_code].
+    /// emitted by the caller of this.
     fn compile_dead_code(&mut self, slot: LocalIdx, node: ast::Expr) {
         self.dead_scope += 1;
         self.compile(slot, node);
diff --git a/tvix/eval/src/value/builtin.rs b/tvix/eval/src/value/builtin.rs
index b6946d786e..346f06cb77 100644
--- a/tvix/eval/src/value/builtin.rs
+++ b/tvix/eval/src/value/builtin.rs
@@ -90,8 +90,9 @@ impl Builtin {
         self.0.documentation
     }
 
-    /// Apply an additional argument to the builtin. After this, [`call`] *must*
-    /// be called, otherwise it may leave the builtin in an incorrect state.
+    /// Apply an additional argument to the builtin.
+    /// After this, [`Builtin::call`] *must* be called, otherwise it may leave
+    /// the builtin in an incorrect state.
     pub fn apply_arg(&mut self, arg: Value) {
         self.0.partials.push(arg);
 
diff --git a/tvix/eval/src/value/function.rs b/tvix/eval/src/value/function.rs
index 1a32795393..77ac7112d2 100644
--- a/tvix/eval/src/value/function.rs
+++ b/tvix/eval/src/value/function.rs
@@ -42,7 +42,7 @@ impl Formals {
 ///
 /// In order to correctly reproduce cppnix's "pointer equality"
 /// semantics it is important that we never clone a Lambda --
-/// use Rc<Lambda>::clone() instead.  This struct deliberately
+/// use `Rc<Lambda>::clone()` instead.  This struct deliberately
 /// does not `derive(Clone)` in order to prevent this from being
 /// done accidentally.
 ///
@@ -58,7 +58,7 @@ pub struct Lambda {
     /// Number of upvalues which the code in this Lambda closes
     /// over, and which need to be initialised at
     /// runtime.  Information about the variables is emitted using
-    /// data-carrying opcodes (see [`OpCode::DataStackIdx`]).
+    /// data-carrying opcodes (see [`crate::opcode::OpCode::DataStackIdx`]).
     pub(crate) upvalue_count: usize,
     pub(crate) formals: Option<Formals>,
 }
@@ -72,7 +72,7 @@ impl Lambda {
 ///
 /// In order to correctly reproduce cppnix's "pointer equality"
 /// semantics it is important that we never clone a Lambda --
-/// use Rc<Lambda>::clone() instead.  This struct deliberately
+/// use `Rc<Lambda>::clone()` instead.  This struct deliberately
 /// does not `derive(Clone)` in order to prevent this from being
 /// done accidentally.
 ///
diff --git a/tvix/eval/src/vm/mod.rs b/tvix/eval/src/vm/mod.rs
index 681b8fb97a..d883b25000 100644
--- a/tvix/eval/src/vm/mod.rs
+++ b/tvix/eval/src/vm/mod.rs
@@ -225,8 +225,8 @@ struct ImportCache(HashMap<PathBuf, Value>);
 /// file, so that the same file doesn't need to be re-evaluated multiple times.
 /// Currently the real path of the imported file (determined using
 /// [`std::fs::canonicalize()`], not to be confused with our
-/// [`value::canon_path()`]) is used to identify the file, just like C++ Nix
-/// does.
+/// [`crate::value::canon_path()`]) is used to identify the file,
+/// just like C++ Nix does.
 ///
 /// Errors while determining the real path are currently just ignored, since we
 /// pass around some fake paths like `/__corepkgs__/fetchurl.nix`.