Browse Source

Merge pull request #11617 from fortkle/fix-phpdoc

Update PHPDoc for Validation::comparison()
Mark Story 8 years ago
parent
commit
a02ac7bcf8
1 changed files with 2 additions and 3 deletions
  1. 2 3
      src/Validation/Validation.php

+ 2 - 3
src/Validation/Validation.php

@@ -238,12 +238,11 @@ class Validation
     /**
      * Used to compare 2 numeric values.
      *
-     * @param string $check1 if string is passed for, a string must also be passed for $check2
-     *    used as an array it must be passed as ['check1' => value, 'operator' => 'value', 'check2' => value]
+     * @param string $check1 The left value to compare.
      * @param string $operator Can be either a word or operand
      *    is greater >, is less <, greater or equal >=
      *    less or equal <=, is less <, equal to ==, not equal !=
-     * @param int $check2 only needed if $check1 is a string
+     * @param int $check2 The right value to compare.
      * @return bool Success
      */
     public static function comparison($check1, $operator, $check2)