From 79c05f38109d2eac07b9ba893b9b6f67fd34c29c Mon Sep 17 00:00:00 2001
From: Jürgen Hahn <mail.jhahn@gmail.com>
Date: Wed, 4 Jan 2023 12:43:18 +0100
Subject: docs(feat/derivation): add docstring to formatter

This is just to clarify that the formatted result is the ATerm representation

Change-Id: I98fd0b1d2daa3cf6fdbe526ae1e0bd100ff62df3
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7742
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
---
 tvix/derivation/src/derivation.rs | 1 +
 1 file changed, 1 insertion(+)

(limited to 'tvix')

diff --git a/tvix/derivation/src/derivation.rs b/tvix/derivation/src/derivation.rs
index 406d2e0a5787..e624be20cab3 100644
--- a/tvix/derivation/src/derivation.rs
+++ b/tvix/derivation/src/derivation.rs
@@ -34,6 +34,7 @@ impl Derivation {
 }
 
 impl fmt::Display for Derivation {
+    /// Formats the Derivation in ATerm representation.
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         self.serialize(f)
     }
-- 
cgit 1.4.1