maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix/eval): fix some broken docstr references

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

5
tvix/eval/src/value/builtin.rs
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);

6
tvix/eval/src/value/function.rs
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.
///