about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-01-31T14·07+0100
committerclbot <clbot@tvl.fyi>2023-01-31T15·16+0000
commit1e28cc7edee0763f1f907af34033acb3a278b546 (patch)
tree99c4d22030cf8298d797c5e71153d13a46ee400d
parent2d24c5f260945216ca01371d4120f5d53f08b2cd (diff)
docs(tvix/nix-compat/derivation): fix docstrings r/5792
Change-Id: I3fd02e62c8a24fa7f27461b17cdd824b060d9bdb
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7968
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
Autosubmit: flokli <flokli@flokli.de>
-rw-r--r--tvix/nix-compat/src/derivation/errors.rs3
-rw-r--r--tvix/nix-compat/src/derivation/validate.rs4
2 files changed, 5 insertions, 2 deletions
diff --git a/tvix/nix-compat/src/derivation/errors.rs b/tvix/nix-compat/src/derivation/errors.rs
index 0dcad9a5345e..80d1e6c6a4a9 100644
--- a/tvix/nix-compat/src/derivation/errors.rs
+++ b/tvix/nix-compat/src/derivation/errors.rs
@@ -42,7 +42,8 @@ pub enum DerivationError {
     InvalidEnvironmentKey(String),
 }
 
-/// Errors that can occur during the validation of a specific [Output] of a [Derviation].
+/// Errors that can occur during the validation of a specific
+// [crate::derivation::Output] of a [crate::derivation::Derviation].
 #[derive(Debug, Error, PartialEq)]
 pub enum OutputError {
     #[error("Invalid ouput path {0}: {1}")]
diff --git a/tvix/nix-compat/src/derivation/validate.rs b/tvix/nix-compat/src/derivation/validate.rs
index 7456f930d15e..91b24f811de4 100644
--- a/tvix/nix-compat/src/derivation/validate.rs
+++ b/tvix/nix-compat/src/derivation/validate.rs
@@ -3,9 +3,11 @@ use crate::store_path::StorePath;
 
 impl Derivation {
     /// validate ensures a Derivation struct is properly populated,
-    /// and returns a [ValidateDerivationError] if not.
+    /// and returns a [DerivationError] if not.
+    ///
     /// if `validate_output_paths` is set to false, the output paths are
     /// excluded from validation.
+    ///
     /// This is helpful to validate struct population before invoking
     /// [Derivation::calculate_output_paths].
     pub fn validate(&self, validate_output_paths: bool) -> Result<(), DerivationError> {