@@ -104,7 +104,7 @@ public class GitHub {
104
104
* to represent different ways of authentication.
105
105
*
106
106
* <dl>
107
- * <dt>Loging anonymously
107
+ * <dt>Log in anonymously
108
108
* <dd>Leave all three parameters null and you will be making HTTP requests without any authentication.
109
109
*
110
110
* <dt>Log in with password
@@ -123,7 +123,7 @@ public class GitHub {
123
123
* For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.
124
124
* Password is also considered deprecated as it is no longer required for api usage.
125
125
* @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
127
127
* provided or if logging in anonymously. Specifying this would save one API call.
128
128
* @param oauthAccessToken
129
129
* Secret OAuth token.
@@ -180,7 +180,7 @@ public static GitHub connectToEnterprise(String apiUrl, String oauthAccessToken)
180
180
* Version that connects to GitHub Enterprise.
181
181
*
182
182
* @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
184
184
* "http://ghe.acme.com/api/v3". Note that GitHub Enterprise has <tt>/api/v3</tt> in the URL.
185
185
* For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.
186
186
*/
@@ -225,7 +225,7 @@ public static GitHub connectUsingOAuth(String githubServer, String oauthAccessTo
225
225
/**
226
226
* Connects to GitHub anonymously.
227
227
*
228
- * All operations that requires authentication will fail.
228
+ * All operations that require authentication will fail.
229
229
*/
230
230
public static GitHub connectAnonymously () throws IOException {
231
231
return new GitHubBuilder ().build ();
@@ -234,7 +234,7 @@ public static GitHub connectAnonymously() throws IOException {
234
234
/**
235
235
* Connects to GitHub Enterprise anonymously.
236
236
*
237
- * All operations that requires authentication will fail.
237
+ * All operations that require authentication will fail.
238
238
*/
239
239
public static GitHub connectToEnterpriseAnonymously (String apiUrl ) throws IOException {
240
240
return new GitHubBuilder ().withEndpoint (apiUrl ).build ();
@@ -404,7 +404,7 @@ public GHUser getUser(String login) throws IOException {
404
404
405
405
406
406
/**
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
408
408
*/
409
409
public void refreshCache () {
410
410
users .clear ();
@@ -484,8 +484,6 @@ public GHRepository getRepositoryById(String id) throws IOException {
484
484
/**
485
485
* Returns a list of popular open source licenses
486
486
*
487
- * WARNING: This uses a PREVIEW API.
488
- *
489
487
* @see <a href="https://developer.github.com/v3/licenses/">GitHub API - Licenses</a>
490
488
*
491
489
* @return a list of popular open source licenses
@@ -548,7 +546,7 @@ public List<GHInvitation> getMyInvitations() throws IOException {
548
546
}
549
547
550
548
/**
551
- * This method returns a shallowly populated organizations.
549
+ * This method returns shallowly populated organizations.
552
550
*
553
551
* To retrieve full organization details, you need to call {@link #getOrganization(String)}
554
552
* TODO: make this automatic.
@@ -603,7 +601,7 @@ public List<GHEventInfo> getEvents() throws IOException {
603
601
}
604
602
605
603
/**
606
- * Gets a sigle gist by ID.
604
+ * Gets a single gist by ID.
607
605
*/
608
606
public GHGist getGist (String id ) throws IOException {
609
607
return retrieve ().to ("/gists/" +id ,GHGist .class ).wrapUp (this );
@@ -643,7 +641,7 @@ public GHRepository createRepository(String name, String description, String hom
643
641
*
644
642
* <p>
645
643
* 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.
647
645
*
648
646
* <p>
649
647
* To create a repository in an organization, see
0 commit comments