about summary refs log tree commit diff
path: root/tvix/derivation/src/derivation.rs
diff options
context:
space:
mode:
authorJürgen Hahn <mail.jhahn@gmail.com>2023-01-04T11·43+0100
committerjrhahn <mail.jhahn@gmail.com>2023-01-04T12·10+0000
commit79c05f38109d2eac07b9ba893b9b6f67fd34c29c (patch)
tree8a493861b13340ce372779d27e239f194be29597 /tvix/derivation/src/derivation.rs
parent4d38e69adf962cb664b923d98dfb6bf658fc0819 (diff)
docs(feat/derivation): add docstring to formatter r/5579
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>
Diffstat (limited to 'tvix/derivation/src/derivation.rs')
-rw-r--r--tvix/derivation/src/derivation.rs1
1 files changed, 1 insertions, 0 deletions
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)
     }