From 473a9054fd4527fec070e9146fa21a04628e1ff7 Mon Sep 17 00:00:00 2001
From: Edoardo La Greca
Date: Wed, 6 Aug 2025 21:45:48 +0200
Subject: add clarification to ProtocolTranslator

---
 src/main/kotlin/ProtocolTranslator.kt | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/main/kotlin')

diff --git a/src/main/kotlin/ProtocolTranslator.kt b/src/main/kotlin/ProtocolTranslator.kt
index 82c530a..9d2afbc 100644
--- a/src/main/kotlin/ProtocolTranslator.kt
+++ b/src/main/kotlin/ProtocolTranslator.kt
@@ -10,6 +10,10 @@ TODO:
  *
  * Tags are supposed to be managed internally by the class that provides the implementation.
  *
+ * When compared to 9P's formal message descriptions, like those which can be read in Plan 9's manual pages, some of the
+ * methods might lack parameters. Those which can be inferred from the existing parameters are purposefully omitted. An
+ * example is [walk], which omits `nwname` because it can be obtained by calculating the size of `wname`.
+ *
  * Trivia: comments for each method are taken from each message type's manual page in section 5.
  */
 interface ProtocolTranslator {
-- 
cgit v1.2.3