Merge pull request #8162 from kenjis/docs-fix-lang-return-type

kenjis · web-flow · commit 56ed44420eea · 2023-11-08T06:52:36.000+09:00
docs: fix return type for lang()
diff --git a/system/Common.php b/system/Common.php
@@ -755,7 +755,7 @@ function is_windows(?bool $mock = null): bool
      * A convenience method to translate a string or array of them and format
      * the result with the intl extension's MessageFormatter.
      *
-     * @return string
+     * @return list<string>|string
      */
     function lang(string $line, array $args = [], ?string $locale = null)
     {
diff --git a/system/Language/Language.php b/system/Language/Language.php
@@ -88,7 +88,7 @@ public function getLocale(): string
      * Parses the language string for a file, loads the file, if necessary,
      * getting the line.
      *
-     * @return string|string[]
+     * @return list<string>|string
      */
     public function getLine(string $line, array $args = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -755,7 +755,7 @@ function is_windows(?bool $mock = null): bool`
`755`	`755`	`* A convenience method to translate a string or array of them and format`
`756`	`756`	`* the result with the intl extension's MessageFormatter.`
`757`	`757`	`*`
`758`		`- * @return string`
	`758`	`+ * @return list<string>\|string`
`759`	`759`	`*/`
`760`	`760`	`function lang(string $line, array $args = [], ?string $locale = null)`
`761`	`761`	`{`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public function getLocale(): string`
`88`	`88`	`* Parses the language string for a file, loads the file, if necessary,`
`89`	`89`	`* getting the line.`
`90`	`90`	`*`
`91`		`- * @return string\|string[]`
	`91`	`+ * @return list<string>\|string`
`92`	`92`	`*/`
`93`	`93`	`public function getLine(string $line, array $args = [])`
`94`	`94`	`{`