Comment & String Fixes

THE-Spellchecker · THE-Spellchecker · commit 722d2737d62e · 2023-01-18T01:08:29.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -82,7 +82,7 @@ When modifying existing tests, you can change the stubbed WireMock data files by
 #### Manual editing of data (minor changes only)
 
 If you know what data will change, it is sometimes simplest to make any required changes to the data files manually.
-This can be easier if the changes are minor or when you development environment is not setup to to take updated snapshots.
+This can be easier if the changes are minor or when you development environment is not setup to take updated snapshots.
 
 #### Generating a new snapshot
 
diff --git a/src/main/java/org/kohsuke/github/GHCommit.java b/src/main/java/org/kohsuke/github/GHCommit.java
@@ -125,7 +125,7 @@ public static class Stats {
     /**
      * A file that was modified.
      */
-    @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "It's being initilized by JSON deserialization")
+    @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "It's being initialized by JSON deserialization")
     public static class File {
 
         /** The status. */
diff --git a/src/main/java/org/kohsuke/github/GHCompare.java b/src/main/java/org/kohsuke/github/GHCompare.java
@@ -224,7 +224,7 @@ GHCompare lateBind(GHRepository owner) {
     }
 
     /**
-     * Compare commits had a child commit element with additional details we want to capture. This extenstion of
+     * Compare commits had a child commit element with additional details we want to capture. This extension of
      * GHCommit provides that.
      */
     @SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD" },
diff --git a/src/main/java/org/kohsuke/github/GHFileNotFoundException.java b/src/main/java/org/kohsuke/github/GHFileNotFoundException.java
@@ -10,7 +10,7 @@
 
 // TODO: Auto-generated Javadoc
 /**
- * Request/responce contains useful metadata. Custom exception allows store info for next diagnostics.
+ * Request/response contains useful metadata. Custom exception allows store info for next diagnostics.
  *
  * @author Kanstantsin Shautsou
  */
diff --git a/src/main/java/org/kohsuke/github/GHIOException.java b/src/main/java/org/kohsuke/github/GHIOException.java
@@ -10,7 +10,7 @@
 
 // TODO: Auto-generated Javadoc
 /**
- * Request/responce contains useful metadata. Custom exception allows store info for next diagnostics.
+ * Request/response contains useful metadata. Custom exception allows store info for next diagnostics.
  *
  * @author Kanstantsin Shautsou
  */
diff --git a/src/main/java/org/kohsuke/github/GHIssue.java b/src/main/java/org/kohsuke/github/GHIssue.java
@@ -517,7 +517,7 @@ public List<GHIssueComment> getComments() throws IOException {
     }
 
     /**
-     * Obtains all the comments associated with this issue, witout any filter.
+     * Obtains all the comments associated with this issue, without any filter.
      *
      * @return the paged iterable
      * @throws IOException
diff --git a/src/main/java/org/kohsuke/github/GHMyself.java b/src/main/java/org/kohsuke/github/GHMyself.java
@@ -70,9 +70,9 @@ public List<GHEmail> getEmails2() throws IOException {
     }
 
     /**
-     * Returns the read-only list of all the pulic keys of the current user.
+     * Returns the read-only list of all the public keys of the current user.
      * <p>
-     * NOTE: When using OAuth authenticaiton, the READ/WRITE User scope is required by the GitHub APIs, otherwise you
+     * NOTE: When using OAuth authentication, the READ/WRITE User scope is required by the GitHub APIs, otherwise you
      * will get a 404 NOT FOUND.
      *
      * @return Always non-null.
diff --git a/src/main/java/org/kohsuke/github/GHOrganization.java b/src/main/java/org/kohsuke/github/GHOrganization.java
@@ -655,7 +655,7 @@ public List<GHRepository> getRepositoriesWithOpenPullRequests() throws IOExcepti
     }
 
     /**
-     * Gets all the open pull requests in this organizataion.
+     * Gets all the open pull requests in this organization.
      *
      * @return the pull requests
      * @throws IOException
diff --git a/src/main/java/org/kohsuke/github/GHRateLimit.java b/src/main/java/org/kohsuke/github/GHRateLimit.java
@@ -347,7 +347,7 @@ Record getRecord(@Nonnull RateLimitTarget rateLimitTarget) {
     }
 
     /**
-     * A limit record used as a placeholder when the the actual limit is not known.
+     * A limit record used as a placeholder when the actual limit is not known.
      *
      * @since 1.100
      */
@@ -528,7 +528,7 @@ && getRemaining() <= other.getRemaining())) {
             } else if (!(other instanceof UnknownLimitRecord)) {
                 // If the above is not the case that means other has a later reset
                 // or the same resent and fewer requests remaining.
-                // If the other record is not an unknown record, the the other is more recent
+                // If the other record is not an unknown record, the other is more recent
                 return other;
             } else if (this.isExpired() && !other.isExpired()) {
                 // The other is an unknown record.
diff --git a/src/main/java/org/kohsuke/github/GHRef.java b/src/main/java/org/kohsuke/github/GHRef.java
@@ -85,7 +85,7 @@ public void delete() throws IOException {
     }
 
     /**
-     * Retrive a ref of the given type for the current GitHub repository.
+     * Retrieve a ref of the given type for the current GitHub repository.
      *
      * @param repository
      *            the repository to read from
diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java
@@ -1891,7 +1891,7 @@ public GHCompare getCompare(GHBranch id1, GHBranch id2) throws IOException {
     /**
      * Retrieves all refs for the github repository.
      *
-     * @return an array of GHRef elements coresponding with the refs in the remote repository.
+     * @return an array of GHRef elements corresponding with the refs in the remote repository.
      * @throws IOException
      *             on failure communicating with GitHub
      */
@@ -1937,7 +1937,7 @@ public PagedIterable<GHRef> listRefs(String refType) throws IOException {
     }
 
     /**
-     * Retrive a ref of the given type for the current GitHub repository.
+     * Retrieve a ref of the given type for the current GitHub repository.
      *
      * @param refName
      *            eg: heads/branch
@@ -1964,7 +1964,7 @@ public GHTagObject getTagObject(String sha) throws IOException {
     }
 
     /**
-     * Retrive a tree of the given type for the current GitHub repository.
+     * Retrieve a tree of the given type for the current GitHub repository.
      *
      * @param sha
      *            sha number or branch name ex: "main"
@@ -2222,7 +2222,7 @@ public PagedIterable<GHCheckRun> getCheckRuns(String ref) throws IOException {
      * @param description
      *            Optional short description.
      * @param context
-     *            Optinal commit status context.
+     *            Optional commit status context.
      * @return the gh commit status
      * @throws IOException
      *             the io exception
diff --git a/src/main/java/org/kohsuke/github/GHTree.java b/src/main/java/org/kohsuke/github/GHTree.java
@@ -61,7 +61,7 @@ public GHTreeEntry getEntry(String path) {
     /**
      * Returns true if the number of items in the tree array exceeded the GitHub maximum limit.
      *
-     * @return true true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false.
+     * @return true if the number of items in the tree array exceeded the GitHub maximum limit otherwise false.
      */
     public boolean isTruncated() {
         return truncated;
diff --git a/src/main/java/org/kohsuke/github/GHVerification.java b/src/main/java/org/kohsuke/github/GHVerification.java
@@ -9,9 +9,9 @@
  *
  * @author Sourabh Sarvotham Parkala
  * @see <a href="https://developer.github.com/v3/git/tags/#signature-verification-object">tags signature
- *      verificatiion</a>
+ *      verification</a>
  * @see <a href="https://developer.github.com/v3/git/commits/#signature-verification-object">commits signature
- *      verificatiion</a>
+ *      verification</a>
  */
 @SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD" },
         justification = "JSON API")
@@ -32,7 +32,7 @@ public boolean isVerified() {
     /**
      * Gets reason for verification value.
      *
-     * @return return reason of type {@link Reason}, such as "valid" or "unsigned". The possible values can be found in
+     * @return reason of type {@link Reason}, such as "valid" or "unsigned". The possible values can be found in
      *         {@link Reason}}
      */
     public Reason getReason() {
diff --git a/src/main/java/org/kohsuke/github/GitHubRequest.java b/src/main/java/org/kohsuke/github/GitHubRequest.java
@@ -228,7 +228,7 @@ public String urlPath() {
     }
 
     /**
-     * The content type to to be sent by this request.
+     * The content type to be sent by this request.
      *
      * @return the content type.
      */
@@ -262,7 +262,7 @@ public URL url() {
     /**
      * Whether arguments for this request should be included in the URL or in the body of the request.
      *
-     * @return true if the arguements should be sent in the body of the request.
+     * @return true if the arguments should be sent in the body of the request.
      */
     @Override
     public boolean hasBody() {
diff --git a/src/main/java/org/kohsuke/github/example/dataobject/ReadOnlyObjects.java b/src/main/java/org/kohsuke/github/example/dataobject/ReadOnlyObjects.java
@@ -94,7 +94,7 @@ public interface GHMetaExample {
      * <ul>
      * <li>Easy to create</li>
      * <li>Not much code</li>
-     * <li>Mininal annotations</li>
+     * <li>Minimal annotations</li>
      * </ul>
      * Con:
      * <ul>
@@ -373,7 +373,7 @@ void setImporter(List<String> importer) {
      * <ul>
      * <li>Very Easy to create</li>
      * <li>Minimal code</li>
-     * <li>Mininal annotations</li>
+     * <li>Minimal annotations</li>
      * <li>Fields effectively final and lists unmodifiable</li>
      * </ul>
      * Con:
diff --git a/src/main/java/org/kohsuke/github/extras/authorization/JWTTokenProvider.java b/src/main/java/org/kohsuke/github/extras/authorization/JWTTokenProvider.java
@@ -122,7 +122,7 @@ public String getEncodedAuthorization() throws IOException {
      * <p>
      * Made internal for testing
      *
-     * @return false if the the token has been refreshed within the required window, otherwise true
+     * @return false if the token has been refreshed within the required window, otherwise true
      */
     boolean isNotValid() {
         return Instant.now().isAfter(validUntil);
diff --git a/src/main/java/org/kohsuke/github/internal/GitHubConnectorHttpConnectorAdapter.java b/src/main/java/org/kohsuke/github/internal/GitHubConnectorHttpConnectorAdapter.java
@@ -83,7 +83,7 @@ public GitHubConnectorResponse send(GitHubConnectorRequest request) throws IOExc
         }
 
         // HttpUrlConnection is nuts. This call opens the connection and gets a response.
-        // Putting this on it's own line for ease of debugging if needed.
+        // Putting this on its own line for ease of debugging if needed.
         int statusCode = connection.getResponseCode();
         Map<String, List<String>> headers = connection.getHeaderFields();
 

Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ GHCompare lateBind(GHRepository owner) {`
`224`	`224`	`}`
`225`	`225`
`226`	`226`	`/**`
`227`		`- * Compare commits had a child commit element with additional details we want to capture. This extenstion of`
	`227`	`+ * Compare commits had a child commit element with additional details we want to capture. This extension of`
`228`	`228`	`* GHCommit provides that.`
`229`	`229`	`*/`
`230`	`230`	`@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD" },`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`
`11`	`11`	`// TODO: Auto-generated Javadoc`
`12`	`12`	`/**`
`13`		`- * Request/responce contains useful metadata. Custom exception allows store info for next diagnostics.`
	`13`	`+ * Request/response contains useful metadata. Custom exception allows store info for next diagnostics.`
`14`	`14`	`*`
`15`	`15`	`* @author Kanstantsin Shautsou`
`16`	`16`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -517,7 +517,7 @@ public List<GHIssueComment> getComments() throws IOException {`
`517`	`517`	`}`
`518`	`518`
`519`	`519`	`/**`
`520`		`- * Obtains all the comments associated with this issue, witout any filter.`
	`520`	`+ * Obtains all the comments associated with this issue, without any filter.`
`521`	`521`	`*`
`522`	`522`	`* @return the paged iterable`
`523`	`523`	`* @throws IOException`
Original file line number	Diff line number	Diff line change
`@@ -70,9 +70,9 @@ public List<GHEmail> getEmails2() throws IOException {`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * Returns the read-only list of all the pulic keys of the current user.`
	`73`	`+ * Returns the read-only list of all the public keys of the current user.`
`74`	`74`	`* <p>`
`75`		`- * NOTE: When using OAuth authenticaiton, the READ/WRITE User scope is required by the GitHub APIs, otherwise you`
	`75`	`+ * NOTE: When using OAuth authentication, the READ/WRITE User scope is required by the GitHub APIs, otherwise you`
`76`	`76`	`* will get a 404 NOT FOUND.`
`77`	`77`	`*`
`78`	`78`	`* @return Always non-null.`
Original file line number	Diff line number	Diff line change
`@@ -655,7 +655,7 @@ public List<GHRepository> getRepositoriesWithOpenPullRequests() throws IOExcepti`
`655`	`655`	`}`
`656`	`656`
`657`	`657`	`/**`
`658`		`- * Gets all the open pull requests in this organizataion.`
	`658`	`+ * Gets all the open pull requests in this organization.`
`659`	`659`	`*`
`660`	`660`	`* @return the pull requests`
`661`	`661`	`* @throws IOException`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public void delete() throws IOException {`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/**`
`88`		`- * Retrive a ref of the given type for the current GitHub repository.`
	`88`	`+ * Retrieve a ref of the given type for the current GitHub repository.`
`89`	`89`	`*`
`90`	`90`	`* @param repository`
`91`	`91`	`* the repository to read from`