Skip to content

Commit b9bf47a

Browse files
bitwisemanbitwiseman
authored
Merge pull request hub4j#543 from jsoref/grammar
Grammar
2 parents c845846 + 0dba882 commit b9bf47a

2 files changed

Lines changed: 11 additions & 13 deletions

File tree

‎src/main/java/org/kohsuke/github/AbuseLimitHandler.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public abstract class AbuseLimitHandler {
2424
* @see <a href="https://developer.github.com/v3/#abuse-rate-limits">API documentation from GitHub</a>
2525
* @param e
2626
* Exception from Java I/O layer. If you decide to fail the processing, you can throw
27-
* this exception (or wrap this exception into another exception and throw it.)
27+
* this exception (or wrap this exception into another exception and throw it).
2828
* @param uc
2929
* Connection that resulted in an error. Useful for accessing other response headers.
3030
*/
@@ -57,7 +57,7 @@ private long parseWaitTime(HttpURLConnection uc) {
5757
public static final AbuseLimitHandler FAIL = new AbuseLimitHandler() {
5858
@Override
5959
public void onError(IOException e, HttpURLConnection uc) throws IOException {
60-
throw (IOException)new IOException("Abust limit reached").initCause(e);
60+
throw (IOException)new IOException("Abuse limit reached").initCause(e);
6161
}
6262
};
6363
}

‎src/main/java/org/kohsuke/github/GitHub.java‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public class GitHub {
104104
* to represent different ways of authentication.
105105
*
106106
* <dl>
107-
* <dt>Loging anonymously
107+
* <dt>Log in anonymously
108108
* <dd>Leave all three parameters null and you will be making HTTP requests without any authentication.
109109
*
110110
* <dt>Log in with password
@@ -123,7 +123,7 @@ public class GitHub {
123123
* For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.
124124
* Password is also considered deprecated as it is no longer required for api usage.
125125
* @param login
126-
* The use ID on GitHub that you are logging in as. Can be omitted if the OAuth token is
126+
* The user ID on GitHub that you are logging in as. Can be omitted if the OAuth token is
127127
* provided or if logging in anonymously. Specifying this would save one API call.
128128
* @param oauthAccessToken
129129
* Secret OAuth token.
@@ -180,7 +180,7 @@ public static GitHub connectToEnterprise(String apiUrl, String oauthAccessToken)
180180
* Version that connects to GitHub Enterprise.
181181
*
182182
* @param apiUrl
183-
* The URL of GitHub (or GitHub enterprise) API endpoint, such as "https://api.github.com" or
183+
* The URL of GitHub (or GitHub Enterprise) API endpoint, such as "https://api.github.com" or
184184
* "http://ghe.acme.com/api/v3". Note that GitHub Enterprise has <tt>/api/v3</tt> in the URL.
185185
* For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.
186186
*/
@@ -225,7 +225,7 @@ public static GitHub connectUsingOAuth(String githubServer, String oauthAccessTo
225225
/**
226226
* Connects to GitHub anonymously.
227227
*
228-
* All operations that requires authentication will fail.
228+
* All operations that require authentication will fail.
229229
*/
230230
public static GitHub connectAnonymously() throws IOException {
231231
return new GitHubBuilder().build();
@@ -234,7 +234,7 @@ public static GitHub connectAnonymously() throws IOException {
234234
/**
235235
* Connects to GitHub Enterprise anonymously.
236236
*
237-
* All operations that requires authentication will fail.
237+
* All operations that require authentication will fail.
238238
*/
239239
public static GitHub connectToEnterpriseAnonymously(String apiUrl) throws IOException {
240240
return new GitHubBuilder().withEndpoint(apiUrl).build();
@@ -404,7 +404,7 @@ public GHUser getUser(String login) throws IOException {
404404

405405

406406
/**
407-
* clears all cached data in order for external changes (modifications and del
407+
* clears all cached data in order for external changes (modifications and del) to be reflected
408408
*/
409409
public void refreshCache() {
410410
users.clear();
@@ -484,8 +484,6 @@ public GHRepository getRepositoryById(String id) throws IOException {
484484
/**
485485
* Returns a list of popular open source licenses
486486
*
487-
* WARNING: This uses a PREVIEW API.
488-
*
489487
* @see <a href="https://developer.github.com/v3/licenses/">GitHub API - Licenses</a>
490488
*
491489
* @return a list of popular open source licenses
@@ -548,7 +546,7 @@ public List<GHInvitation> getMyInvitations() throws IOException {
548546
}
549547

550548
/**
551-
* This method returns a shallowly populated organizations.
549+
* This method returns shallowly populated organizations.
552550
*
553551
* To retrieve full organization details, you need to call {@link #getOrganization(String)}
554552
* TODO: make this automatic.
@@ -603,7 +601,7 @@ public List<GHEventInfo> getEvents() throws IOException {
603601
}
604602

605603
/**
606-
* Gets a sigle gist by ID.
604+
* Gets a single gist by ID.
607605
*/
608606
public GHGist getGist(String id) throws IOException {
609607
return retrieve().to("/gists/"+id,GHGist.class).wrapUp(this);
@@ -643,7 +641,7 @@ public GHRepository createRepository(String name, String description, String hom
643641
*
644642
* <p>
645643
* You use the returned builder to set various properties, then call {@link GHCreateRepositoryBuilder#create()}
646-
* to finally createa repository.
644+
* to finally create a repository.
647645
*
648646
* <p>
649647
* To create a repository in an organization, see

0 commit comments

Comments
 (0)