From 647e3646c2f686ce236059b935336c43c8a9a074 Mon Sep 17 00:00:00 2001
From: Johannes Stoelp <johannes.stoelp@gmail.com>
Date: Thu, 7 Dec 2023 22:26:57 +0100
Subject: insn: enhance cmp doc

---
 src/insn.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/insn.rs b/src/insn.rs
index 11405c1..e5a597e 100644
--- a/src/insn.rs
+++ b/src/insn.rs
@@ -23,7 +23,10 @@ pub trait Call<T> {
 }
 
 pub trait Cmp<T, U> {
-    /// Emit a compare call instruction.
+    /// Emit a compare instruction.
+    ///
+    /// Computes `op2 - op1` and sets the status flags in the same way as the `sub` instruction,
+    /// the result is discarded.
     fn cmp(&mut self, op1: T, op2: U);
 }
 
-- 
cgit v1.2.3