From 099f4d822fe176d5ba205cb31921dcba07aa4d15 Mon Sep 17 00:00:00 2001
From: Nelson Martell <nelson6e65@gmail.com>
Date: Wed, 2 Jan 2019 07:21:11 -0400
Subject: [PATCH] :memo: :art: Improve description of method `equals()`

(related to #21 )
---
 src/IEquatable.php   | 2 +-
 src/IntString.php    | 2 +-
 src/StrictObject.php | 6 ++----
 src/Type.php         | 4 +++-
 src/Version.php      | 2 +-
 5 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/IEquatable.php b/src/IEquatable.php
index b1ce0c0..3100013 100644
--- a/src/IEquatable.php
+++ b/src/IEquatable.php
@@ -27,7 +27,7 @@ interface IEquatable
 {
 
     /**
-     * Indica si el objeto especificado es igual a la instancia actual.
+     * Indicates whether the specified object is equal to the current instance.
      *
      * @param mixed $other Another object to compare equality.
      *
diff --git a/src/IntString.php b/src/IntString.php
index 9b8604a..7afb445 100644
--- a/src/IntString.php
+++ b/src/IntString.php
@@ -171,7 +171,7 @@ public function toString()
     }
 
     /**
-     * Indica si el objeto especificado es igual a la instancia actual.
+     * Indicates whether the specified object is equal to the current instance.
      *
      * @param IntString|mixed $other
      *
diff --git a/src/StrictObject.php b/src/StrictObject.php
index 231e6f4..4480c27 100644
--- a/src/StrictObject.php
+++ b/src/StrictObject.php
@@ -82,13 +82,11 @@ public function toString()
     }
 
     /**
-     * Indica si el objeto especificado es igual a la instancia actual.
-     *
-     * Note: This methods must to be overriden.
+     * Indicates whether the specified object is equal to the current instance.
      *
      * @param mixed $other Another object to compare equality.
      *
-     * @return bool
+     * @return bool Retuns default behaviour of `==`. ***This method must be overridden***.
      * */
     public function equals($other)
     {
diff --git a/src/Type.php b/src/Type.php
index 252f788..2a0398c 100644
--- a/src/Type.php
+++ b/src/Type.php
@@ -296,9 +296,11 @@ public function toString()
 
 
     /**
+     * Indicates whether the specified object is equal to the current instance.
+     *
      * @param Type|mixed $other
      *
-     * @return bool
+     * @return bool Returns always `false` if `$other` is not a `Type`.
      */
     public function equals($other)
     {
diff --git a/src/Version.php b/src/Version.php
index 195b876..cc3c9b6 100644
--- a/src/Version.php
+++ b/src/Version.php
@@ -325,7 +325,7 @@ public function isValid()
     }
 
     /**
-     * Determina si el objeto $other especificado es igual a la instancia actual.
+     * Indicates whether the specified object is equal to the current instance.
      *
      * @param Version $other El otro objeto a comparar.
      *