Fixed the @return type for Repo::readme() (#627)

brandonkelly · acrobat · commit 13003af4d8f5 · 2017-10-13T08:47:44.000+02:00
* Fixed the @return type for Repo::readme() * readme() can return an array if $format = v3+json
diff --git a/lib/Github/Api/Repo.php b/lib/Github/Api/Repo.php
@@ -256,9 +256,9 @@ public function remove($username, $repository)
      *
      * @param string $username   the user who owns the repository
      * @param string $repository the name of the repository
-     * @param string $format     one of formats: "raw" or "html"
+     * @param string $format     one of formats: "raw", "html", or "v3+json"
      *
-     * @return array the readme content
+     * @return string|array the readme content
      */
     public function readme($username, $repository, $format = 'raw')
     {

Original file line number	Diff line number	Diff line change
`@@ -256,9 +256,9 @@ public function remove($username, $repository)`
`256`	`256`	`*`
`257`	`257`	`* @param string $username the user who owns the repository`
`258`	`258`	`* @param string $repository the name of the repository`
`259`		`- * @param string $format one of formats: "raw" or "html"`
	`259`	`+ * @param string $format one of formats: "raw", "html", or "v3+json"`
`260`	`260`	`*`
`261`		`- * @return array the readme content`
	`261`	`+ * @return string\|array the readme content`
`262`	`262`	`*/`
`263`	`263`	`public function readme($username, $repository, $format = 'raw')`
`264`	`264`	`{`