add clarification to ProtocolTranslator

1 files changed, 4 insertions, 0 deletions

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 {