From 4ad3d7f1237e01d2772558e6f0840593e87a33fc Mon Sep 17 00:00:00 2001
From: Ivan Enderlin <ivan.enderlin@hoa-project.net>
Date: Sat, 4 Apr 2020 08:10:38 +0200
Subject: [PATCH] doc(interface-types) Explain a part of an algorithm.

---
 lib/interface-types/src/interpreter/wasm/serde/ser.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/interface-types/src/interpreter/wasm/serde/ser.rs b/lib/interface-types/src/interpreter/wasm/serde/ser.rs
index e56ecab53..dd3cfb9ea 100644
--- a/lib/interface-types/src/interpreter/wasm/serde/ser.rs
+++ b/lib/interface-types/src/interpreter/wasm/serde/ser.rs
@@ -87,6 +87,8 @@ impl Serializer {
     }
 
     fn pop(&mut self) -> Result<Vec<InterfaceValue>, SerializeError> {
+        // The first `vec` contains the final result. It is forbidden
+        // to `pop` it as is.
         if self.values.len() < 2 {
             Err(SerializeError::InternalValuesCorrupted)
         } else {