Update PHPDocs

Author: natanfelles

src/Database.php

@@ -300,7 +300,7 @@ public function warnings() : int
     }
 
     /**
-     * Get a list of latest errors.
+     * Get a list of the latest errors.
      *
      * @return array<int,array<string,mixed>>
      */
@@ -647,7 +647,8 @@ public function transaction(callable $statements) : void
     /**
      * Gets the LAST_INSERT_ID().
      *
-     * Note: When a insert has many rows, this function returns the id of the first row inserted!
+     * Note: When an insert has many rows, this function returns the id of the
+     * first row inserted!
      * That is default on MySQL.
      *
      * @return int|string

src/Manipulation/Insert.php

@@ -182,7 +182,7 @@ protected function renderOnDuplicateKeyUpdate() : ?string
     /**
      * Check for conflicts in the INSERT statement.
      *
-     * @throws LogicException if has conflicts
+     * @throws LogicException if it has conflicts
      */
     protected function checkRowStatementsConflict() : void
     {

src/Manipulation/Select.php

@@ -36,7 +36,7 @@ class Select extends Statement
      */
     public const OPT_ALL = 'ALL';
     /**
-     * Option to not retrieve identical rows. Remove duplicates from the resultset.
+     * Option to not retrieve identical rows. Remove duplicates from the result set.
      *
      * @see Select::renderOptions()
      * @see https://mariadb.com/kb/en/select/#distinct
@@ -324,7 +324,7 @@ protected function renderProcedure() : ?string
      * @param string $filename
      * @param string|null $charset
      * @param array<string,string> $fieldsOptions Each key must be one of the EXP_FIELDS_* constants
-     * @param array<string,string> $linesOptions Each key must be one of the EXP_LINESS_* constants
+     * @param array<string,string> $linesOptions Each key must be one of the EXP_LINES_* constants
      *
      * @see https://mariadb.com/kb/en/select-into-outfile/
      *

src/Manipulation/Statement.php

@@ -51,7 +51,7 @@ protected function hasOptions() : bool
     abstract protected function renderOptions() : ?string;
 
     /**
-     * Returns a SQL part between parentheses.
+     * Returns an SQL part between parentheses.
      *
      * @param Closure $subquery A {@see Closure} having the current Manipulation
      * instance as first argument. The returned value must be scalar

src/Manipulation/Traits/Having.php

@@ -21,7 +21,7 @@ trait Having
     use Where;
 
     /**
-     * Appends a "AND $column $operator ...$values" condition in the HAVING clause.
+     * Appends an "AND $column $operator ...$values" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param string $operator
@@ -55,7 +55,7 @@ public function orHaving(
     }
 
     /**
-     * Appends a "AND $column = $value" condition in the HAVING clause.
+     * Appends an "AND $column = $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -89,7 +89,7 @@ public function orHavingEqual(
     }
 
     /**
-     * Appends a "AND $column != $value" condition in the HAVING clause.
+     * Appends an "AND $column != $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -123,7 +123,7 @@ public function orHavingNotEqual(
     }
 
     /**
-     * Appends a "AND $column <=> $value" condition in the HAVING clause.
+     * Appends an "AND $column <=> $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -157,7 +157,7 @@ public function orHavingNullSafeEqual(
     }
 
     /**
-     * Appends a "AND $column < $value" condition in the HAVING clause.
+     * Appends an "AND $column < $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -191,7 +191,7 @@ public function orHavingLessThan(
     }
 
     /**
-     * Appends a "AND $column <= $value" condition in the HAVING clause.
+     * Appends an "AND $column <= $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -225,7 +225,7 @@ public function orHavingLessThanOrEqual(
     }
 
     /**
-     * Appends a "AND $column > $value" condition in the HAVING clause.
+     * Appends an "AND $column > $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -259,7 +259,7 @@ public function orHavingGreaterThan(
     }
 
     /**
-     * Appends a "AND $column >= $value" condition in the HAVING clause.
+     * Appends an "AND $column >= $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -293,7 +293,7 @@ public function orHavingGreaterThanOrEqual(
     }
 
     /**
-     * Appends a "AND $column LIKE $value" condition in the HAVING clause.
+     * Appends an "AND $column LIKE $value" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -327,7 +327,7 @@ public function orHavingLike(
     }
 
     /**
-     * Appends a "AND $column NOT LIKE" $value condition.
+     * Appends an "AND $column NOT LIKE" $value condition.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -361,7 +361,7 @@ public function orHavingNotLike(
     }
 
     /**
-     * Appends a "AND $column IN (...$values)" condition in the HAVING clause.
+     * Appends an "AND $column IN (...$values)" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -399,7 +399,7 @@ public function orHavingIn(
     }
 
     /**
-     * Appends a "AND $column NOT IN (...$values)" condition in the HAVING clause.
+     * Appends an "AND $column NOT IN (...$values)" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $value
@@ -437,7 +437,7 @@ public function orHavingNotIn(
     }
 
     /**
-     * Appends a "AND $column BETWEEN $min AND $max" condition in the HAVING clause.
+     * Appends an "AND $column BETWEEN $min AND $max" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $min
@@ -475,7 +475,7 @@ public function orHavingBetween(
     }
 
     /**
-     * Appends a "AND $column NOT BETWEEN $min AND $max" condition in the HAVING clause.
+     * Appends an "AND $column NOT BETWEEN $min AND $max" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      * @param Closure|float|int|string|null $min
@@ -513,7 +513,7 @@ public function orHavingNotBetween(
     }
 
     /**
-     * Appends a "AND $column IS NULL" condition in the HAVING clause.
+     * Appends an "AND $column IS NULL" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      *
@@ -541,7 +541,7 @@ public function orHavingIsNull(Closure | string $column) : static
     }
 
     /**
-     * Appends a "AND $column IS NOT NULL" condition in the HAVING clause.
+     * Appends an "AND $column IS NOT NULL" condition in the HAVING clause.
      *
      * @param Closure|string $column Closure for a subquery or a string with the column name
      *

src/Manipulation/Traits/Join.php

@@ -69,7 +69,7 @@ protected function renderFrom() : ?string
      *
      * @throws LogicException if FROM is not set, but is required for some other clause
      *
-     * @return bool True if has FROM, otherwise false
+     * @return bool True if it has FROM, otherwise false
      */
     protected function hasFrom(string $clause = null) : bool
     {
@@ -89,7 +89,7 @@ protected function hasFrom(string $clause = null) : bool
      * @param string $type JOIN type. One of: `CROSS`, `INNER`, `LEFT`, `LEFT OUTER`,
      * `RIGHT`, `RIGHT OUTER`, `NATURAL`, `NATURAL LEFT`, `NATURAL LEFT OUTER`,
      * `NATURAL RIGHT`, `NATURAL RIGHT OUTER` or empty (same as `INNER`)
-     * @param string|null $clause Condition clause. Null if has a NATURAL type,
+     * @param string|null $clause Condition clause. Null if it has a NATURAL type,
      * otherwise `ON` or `USING`
      * @param array<int,Closure|string>|Closure|null $conditional A conditional
      * expression as Closure or the columns list as array
@@ -355,7 +355,7 @@ public function naturalRightOuterJoin(Closure | string $table) : static
      * `RIGHT OUTER`, `NATURAL`, `NATURAL LEFT`, `NATURAL LEFT OUTER`, `NATURAL RIGHT`
      * or `NATURAL RIGHT OUTER`
      * @param string|null $clause `ON`, `USING` or null for none
-     * @param array<int,Closure|string>|Closure|null $expression Column(s) or subquery(ies)
+     * @param array<Closure|string>|Closure|null $expression Column(s) or subquery(ies)
      *
      * @return static
      */
@@ -405,7 +405,7 @@ protected function renderJoin() : ?string
      * or `NATURAL RIGHT OUTER`
      * @param string $table The table name
      * @param string|null $clause `ON`, `USING` or null for none
-     * @param array<int,Closure|string>|Closure|null $expression Column(s) or subquery(ies)
+     * @param array<Closure|string>|Closure|null $expression Column(s) or subquery(ies)
      *
      * @return string The JOIN conditional part
      */
@@ -471,7 +471,7 @@ private function renderJoinType(string $type) : string
      * @param string $type `NATURAL`, `NATURAL LEFT`, `NATURAL LEFT OUTER`,
      * `NATURAL RIGHT`, `NATURAL RIGHT OUTER` or any other non-natural
      * @param string|null $clause Must be null if type is natural
-     * @param array<int,Closure|string>|Closure|null $expression Must be null if type is natural
+     * @param array<Closure|string>|Closure|null $expression Must be null if type is natural
      *
      * @throws InvalidArgumentException if $type is natural and has clause or expression
      *
@@ -527,7 +527,7 @@ private function renderJoinConditionClause(?string $clause) : ?string
      * Renders the JOIN condition expression.
      *
      * @param string|null $clause `ON`or null
-     * @param array<int,Closure|string>|Closure|null $expression Column(s) or subquery(ies)
+     * @param array<Closure|string>|Closure|null $expression Column(s) or subquery(ies)
      *
      * @return string|null The condition or null if $clause is null
      */