Merge pull request #543 from jsoref/grammar

Grammar
hub4j · Sep 12, 2019 · b9bf47a · b9bf47a
2 parents c845846 + 0dba882
commit b9bf47a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 13 deletions.
diff --git a/src/main/java/org/kohsuke/github/AbuseLimitHandler.java b/src/main/java/org/kohsuke/github/AbuseLimitHandler.java
@@ -24,7 +24,7 @@ public abstract class AbuseLimitHandler {
      * @see <a href="https://developer.github.com/v3/#abuse-rate-limits">API documentation from GitHub</a>
      * @param e
      *      Exception from Java I/O layer. If you decide to fail the processing, you can throw
-     *      this exception (or wrap this exception into another exception and throw it.)
+     *      this exception (or wrap this exception into another exception and throw it).
      * @param uc
      *      Connection that resulted in an error. Useful for accessing other response headers.
      */
@@ -57,7 +57,7 @@ private long parseWaitTime(HttpURLConnection uc) {
     public static final AbuseLimitHandler FAIL = new AbuseLimitHandler() {
         @Override
         public void onError(IOException e, HttpURLConnection uc) throws IOException {
-            throw (IOException)new IOException("Abust limit reached").initCause(e);
+            throw (IOException)new IOException("Abuse limit reached").initCause(e);
         }
     };
 }
diff --git a/src/main/java/org/kohsuke/github/GitHub.java b/src/main/java/org/kohsuke/github/GitHub.java
@@ -104,7 +104,7 @@ public class GitHub {
      * to represent different ways of authentication.
      *
      * <dl>
-     *     <dt>Loging anonymously
+     *     <dt>Log in anonymously
      *     <dd>Leave all three parameters null and you will be making HTTP requests without any authentication.
      *
      *     <dt>Log in with password
@@ -123,7 +123,7 @@ public class GitHub {
      *      For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.
      *      Password is also considered deprecated as it is no longer required for api usage.
      * @param login
-     *      The use ID on GitHub that you are logging in as. Can be omitted if the OAuth token is
+     *      The user ID on GitHub that you are logging in as. Can be omitted if the OAuth token is
      *      provided or if logging in anonymously. Specifying this would save one API call.
      * @param oauthAccessToken
      *      Secret OAuth token.
@@ -180,7 +180,7 @@ public static GitHub connectToEnterprise(String apiUrl, String oauthAccessToken)
      * Version that connects to GitHub Enterprise.
      *
      * @param apiUrl
-     *      The URL of GitHub (or GitHub enterprise) API endpoint, such as "https://api.github.com" or
+     *      The URL of GitHub (or GitHub Enterprise) API endpoint, such as "https://api.github.com" or
      *      "http://ghe.acme.com/api/v3". Note that GitHub Enterprise has <tt>/api/v3</tt> in the URL.
      *      For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.
      */
@@ -225,7 +225,7 @@ public static GitHub connectUsingOAuth(String githubServer, String oauthAccessTo
     /**
      * Connects to GitHub anonymously.
      *
-     * All operations that requires authentication will fail.
+     * All operations that require authentication will fail.
      */
     public static GitHub connectAnonymously() throws IOException {
         return new GitHubBuilder().build();
@@ -234,7 +234,7 @@ public static GitHub connectAnonymously() throws IOException {
     /**
      * Connects to GitHub Enterprise anonymously.
      *
-     * All operations that requires authentication will fail.
+     * All operations that require authentication will fail.
      */
     public static GitHub connectToEnterpriseAnonymously(String apiUrl) throws IOException {
         return new GitHubBuilder().withEndpoint(apiUrl).build();
@@ -404,7 +404,7 @@ public GHUser getUser(String login) throws IOException {
 
 
     /**
-     * clears all cached data in order for external changes (modifications and del
+     * clears all cached data in order for external changes (modifications and del) to be reflected
      */
     public void refreshCache() {
         users.clear();
@@ -484,8 +484,6 @@ public GHRepository getRepositoryById(String id) throws IOException {
     /**
      * Returns a list of popular open source licenses
      *
-     * WARNING: This uses a PREVIEW API.
-     *
      * @see <a href="https://developer.github.com/v3/licenses/">GitHub API - Licenses</a>
      *
      * @return a list of popular open source licenses
@@ -548,7 +546,7 @@ public List<GHInvitation> getMyInvitations() throws IOException {
     }
 
     /**
-     * This method returns a shallowly populated organizations.
+     * This method returns shallowly populated organizations.
      *
      * To retrieve full organization details, you need to call {@link #getOrganization(String)}
      * TODO: make this automatic.
@@ -603,7 +601,7 @@ public List<GHEventInfo> getEvents() throws IOException {
     }
 
     /**
-     * Gets a sigle gist by ID.
+     * Gets a single gist by ID.
      */
     public GHGist getGist(String id) throws IOException {
         return retrieve().to("/gists/"+id,GHGist.class).wrapUp(this);
@@ -643,7 +641,7 @@ public GHRepository createRepository(String name, String description, String hom
      *
      * <p>
      * You use the returned builder to set various properties, then call {@link GHCreateRepositoryBuilder#create()}
-     * to finally createa repository.
+     * to finally create a repository.
      *
      * <p>
      * To create a repository in an organization, see