From eab48667490780cba4b46495166210f9b992e6d1 Mon Sep 17 00:00:00 2001
From: Orange-Murker <23561952+Orange-Murker@users.noreply.github.com>
Date: Fri, 8 Dec 2023 19:24:15 +0100
Subject: [PATCH] Clarified what the phase of cossin is

---
 src/cossin.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/cossin.rs b/src/cossin.rs
index e1af5ae..eb38bb8 100644
--- a/src/cossin.rs
+++ b/src/cossin.rs
@@ -5,7 +5,7 @@ include!(concat!(env!("OUT_DIR"), "/cossin_table.rs"));
 /// <https://github.com/m-labs/misoc/blob/master/misoc/cores/cossin.py>
 ///
 /// # Arguments
-/// * `phase` - 32-bit phase.
+/// * `phase` - 32-bit phase where i32::MIN is -pi and i32::MAX is pi
 ///
 /// # Returns
 /// The cos and sin values of the provided phase as a `(i32, i32)`