From 8b9828c63ec9bafbdd70dd84ac8a724de32ea1a3 Mon Sep 17 00:00:00 2001
From: Mark Canlas <github@htmlism.com>
Date: Wed, 26 Aug 2020 01:16:02 -0400
Subject: [PATCH] document operand behavior

---
 src/main/scala/com/htmlism/mos6502/dsl/Operand.scala | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/main/scala/com/htmlism/mos6502/dsl/Operand.scala b/src/main/scala/com/htmlism/mos6502/dsl/Operand.scala
index 2b9f053..72fd600 100644
--- a/src/main/scala/com/htmlism/mos6502/dsl/Operand.scala
+++ b/src/main/scala/com/htmlism/mos6502/dsl/Operand.scala
@@ -5,10 +5,16 @@ trait Operand[A] {
 
   def toAddressLiteral(x: A): String
 
+  /**
+    * Suitable for comments
+    */
   def toShow(x: A): String
 
   def operandType: OperandType
 
+  /**
+    * The value as presented in a `define` declaration (i.e. where no alias is possible)
+    */
   def toDefinitionLiteral(x: A): String
 }