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 <cbrewster@hey.com>
Autosubmit: flokli <flokli@flokli.de>
This commit is contained in:
Florian Klink 2023-09-22 00:57:20 +03:00 committed by flokli
parent 37a348b4fa
commit 731996fbfe
5 changed files with 11 additions and 10 deletions

View file

@ -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.

View file

@ -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);

View file

@ -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);

View file

@ -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.
///

View file

@ -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`.