From 1e28cc7edee0763f1f907af34033acb3a278b546 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Tue, 31 Jan 2023 15:07:04 +0100 Subject: docs(tvix/nix-compat/derivation): fix docstrings Change-Id: I3fd02e62c8a24fa7f27461b17cdd824b060d9bdb Reviewed-on: https://cl.tvl.fyi/c/depot/+/7968 Tested-by: BuildkiteCI Reviewed-by: tazjin Autosubmit: flokli --- tvix/nix-compat/src/derivation/errors.rs | 3 ++- tvix/nix-compat/src/derivation/validate.rs | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) (limited to 'tvix/nix-compat/src/derivation') diff --git a/tvix/nix-compat/src/derivation/errors.rs b/tvix/nix-compat/src/derivation/errors.rs index 0dcad9a534..80d1e6c6a4 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 7456f930d1..91b24f811d 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> { -- cgit 1.4.1