Issue 1597: Updated Javadoc.

michael-s-grant · michael-s-grant · commit 6b66f2e15893 · 2023-02-01T14:48:38.000+01:00
diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java
@@ -2939,9 +2939,10 @@ private static class GHCodeownersErrors {
     }
 
     /**
-     * List contributors paged iterable.
+     * List errors in the {@code CODEOWNERS} file. Note that GitHub skips lines with incorrect syntax; these are
+     * reported in the web interface, but not in the API call which this library uses.
      *
-     * @return the paged iterable
+     * @return the list of errors
      * @throws IOException
      *             the io exception
      */

Original file line number	Diff line number	Diff line change
`@@ -2939,9 +2939,10 @@ private static class GHCodeownersErrors {`
`2939`	`2939`	`}`
`2940`	`2940`
`2941`	`2941`	`/**`
`2942`		`- * List contributors paged iterable.`
	`2942`	`+ * List errors in the {@code CODEOWNERS} file. Note that GitHub skips lines with incorrect syntax; these are`
	`2943`	`+ * reported in the web interface, but not in the API call which this library uses.`
`2943`	`2944`	`*`
`2944`		`- * @return the paged iterable`
	`2945`	`+ * @return the list of errors`
`2945`	`2946`	`* @throws IOException`
`2946`	`2947`	`* the io exception`
`2947`	`2948`	`*/`