From 731996fbfe5947190443ed70385632a7f9e07e06 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Fri, 22 Sep 2023 00:57:20 +0300 Subject: docs(tvix/eval): fix some broken docstr references 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 Autosubmit: flokli --- tvix/eval/src/chunk.rs | 4 ++-- tvix/eval/src/compiler/mod.rs | 2 +- tvix/eval/src/value/builtin.rs | 5 +++-- tvix/eval/src/value/function.rs | 6 +++--- tvix/eval/src/vm/mod.rs | 4 ++-- 5 files changed, 11 insertions(+), 10 deletions(-) (limited to 'tvix/eval') diff --git a/tvix/eval/src/chunk.rs b/tvix/eval/src/chunk.rs index 9d35b30c64a6..b6fc6be5b99c 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 b7b9192571f7..3ab0e4d93360 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 b6946d786e08..346f06cb7748 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 1a32795393bf..77ac7112d2cb 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::clone() instead. This struct deliberately +/// use `Rc::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, } @@ -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::clone() instead. This struct deliberately +/// use `Rc::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 681b8fb97af4..d883b250001d 100644 --- a/tvix/eval/src/vm/mod.rs +++ b/tvix/eval/src/vm/mod.rs @@ -225,8 +225,8 @@ struct ImportCache(HashMap); /// 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`. -- cgit 1.4.1