From fa16e10529950699f419912797e92ff515c2dfe1 Mon Sep 17 00:00:00 2001
From: CarlosZoft <62192072+CarlosZoft@users.noreply.github.com>
Date: Sun, 24 Apr 2022 16:23:03 -0300
Subject: [PATCH] fix: improving descrition acording suggestion in review

---
 math/modular_inverse_simple.cpp | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/math/modular_inverse_simple.cpp b/math/modular_inverse_simple.cpp
index f64bf2b0e..0b98410c3 100644
--- a/math/modular_inverse_simple.cpp
+++ b/math/modular_inverse_simple.cpp
@@ -3,7 +3,7 @@
  * @brief simple implementation of modular multiplicative inverse
  *
  * @details
- * this algorithm calculates the modular inverse iteratively
+ * this algorithm calculates the modular inverse x^{-1} mod y iteratively
  *
  * @ref
  * https://en.wikipedia.org/wiki/Modular_multiplicative_inverse
@@ -14,7 +14,8 @@
 
 /**
  * @brief Function imod
- *    Responsible for calculating the modular inverse of x with respect to y
+ * Responsible for calculating the modular inverse of x with respect to y,
+ * x^{-1} mod y
  * @param x number
  * @param y number
  * @returns the modular inverse