mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix/nix-compat/derivation): fix docstrings

Browse source 
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>
This commit is contained in:
Florian Klink 2023-01-31 15:07:04 +01:00 committed by clbot
parent 2d24c5f260
commit 1e28cc7ede
2 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
tvix/nix-compat/src/derivation/errors.rs
View file

@ -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}")]

4
tvix/nix-compat/src/derivation/validate.rs
View file

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