Skip to content

Commit

Permalink
spellcheck round 2 (#2259)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dagizmo authored Oct 6, 2020
1 parent 961e0ea commit 66a6781
Show file tree
Hide file tree
Showing 26 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions Octokit/Clients/ICheckSuitesClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public interface ICheckSuitesClient
Task<CheckSuitesResponse> GetAllForReference(long repositoryId, string reference, CheckSuiteRequest request, ApiOptions options);

/// <summary>
/// Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed
/// Updates Check Suites preferences on a repository, such as disabling automatic creation when code is pushed
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository">Check Suites API documentation</a> for more information.
Expand All @@ -113,7 +113,7 @@ public interface ICheckSuitesClient
Task<CheckSuitePreferencesResponse> UpdatePreferences(string owner, string name, CheckSuitePreferences preferences);

/// <summary>
/// Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed
/// Updates Check Suites preferences on a repository, such as disabling automatic creation when code is pushed
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository">Check Suites API documentation</a> for more information.
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Clients/IRepositoryInvitationsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public interface IRepositoryInvitationsClient
/// </remarks>
/// <param name="repositoryId">The id of the repository</param>
/// <param name="invitationId">The id of the invitation</param>
/// <param name="permissions">The permission for the collsborator</param>
/// <param name="permissions">The permission for the collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
Task<RepositoryInvitation> Edit(long repositoryId, int invitationId, InvitationUpdate permissions);
}
Expand Down
4 changes: 2 additions & 2 deletions Octokit/Clients/MigrationsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public async Task<Migration> Start(string org, StartMigrationRequest migration)
}

/// <summary>
/// Gets the list of the most recent migrations of the the organization.
/// Gets the list of the most recent migrations of the organization.
/// </summary>
/// <remarks>
/// https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations
Expand All @@ -57,7 +57,7 @@ public async Task<IReadOnlyList<Migration>> GetAll(string org)
}

/// <summary>
/// Gets the list of the most recent migrations of the the organization.
/// Gets the list of the most recent migrations of the organization.
/// </summary>
/// <remarks>
/// https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Clients/RepositoryInvitationsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public Task<IReadOnlyList<RepositoryInvitation>> GetAllForRepository(long reposi
/// </remarks>
/// <param name="repositoryId">The id of the repository</param>
/// <param name="invitationId">The id of the invitation</param>
/// <param name="permissions">The permission for the collsborator</param>
/// <param name="permissions">The permission for the collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
[ManualRoute("PATCH", "/repositories/{id}/invitations/{invitation_id}")]
public Task<RepositoryInvitation> Edit(long repositoryId, int invitationId, InvitationUpdate permissions)
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Clients/UserGpgKeysClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Octokit
public class UserGpgKeysClient : ApiClient, IUserGpgKeysClient
{
/// <summary>
/// Instatiates a new GitHub User GPG Keys API client.
/// Instantiates a new GitHub User GPG Keys API client.
/// </summary>
/// <param name="apiConnection">The API connection.</param>
public UserGpgKeysClient(IApiConnection apiConnection) : base(apiConnection)
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Clients/UserKeysClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public Task<IReadOnlyList<PublicKey>> GetAllForCurrent()
/// <remarks>
/// https://developer.github.com/v3/users/keys/#list-your-public-keys
/// </remarks>
/// <param name="options">Options to chagne API's behavior.</param>
/// <param name="options">Options to change API's behavior.</param>
/// <returns>Lists the current user's keys.</returns>
[ManualRoute("GET", "/user/keys")]
public Task<IReadOnlyList<PublicKey>> GetAllForCurrent(ApiOptions options)
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Exceptions/RateLimitExceededException.cs
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public override string Message
/// <remarks>
/// The return value is calculated using server time data from the
/// response in order to provide a best-effort estimate that is
/// independant from eventual inaccuracies in the client's clock.
/// independent from eventual inaccuracies in the client's clock.
/// </remarks>
public TimeSpan GetRetryAfterTimeSpan()
{
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Helpers/ApiExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public static class ApiExtensions
/// <typeparam name="T">Type of the API resource in the list.</typeparam>
/// <param name="connection">The connection to use</param>
/// <param name="uri">URI of the API resource to get</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public static Task<IReadOnlyList<T>> GetAll<T>(this IApiConnection connection, Uri uri)
{
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Helpers/ApiUrls.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3714,7 +3714,7 @@ public static Uri UserInvitations(int invitationId)
}

/// <summary>
/// Returns the <see cref="Uri"/> for repository traffice referrers.
/// Returns the <see cref="Uri"/> for repository traffic referrers.
/// </summary>
/// <param name="owner">The owner of repo</param>
/// <param name="repo">The name of repo</param>
Expand Down
14 changes: 7 additions & 7 deletions Octokit/Http/ApiConnection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class ApiConnection : IApiConnection
/// Initializes a new instance of the <see cref="ApiConnection"/> class.
/// </summary>
/// <param name="connection">A connection for making HTTP requests</param>
/// <param name="pagination">A paginator for paging API responses</param>
/// <param name="pagination">A pagination for paging API responses</param>
protected ApiConnection(IConnection connection, IApiPagination pagination)
{
Ensure.ArgumentNotNull(connection, nameof(connection));
Expand Down Expand Up @@ -126,7 +126,7 @@ public async Task<byte[]> GetRaw(Uri uri, IDictionary<string, string> parameters
/// </summary>
/// <typeparam name="T">Type of the API resource in the list.</typeparam>
/// <param name="uri">URI of the API resource to get</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public Task<IReadOnlyList<T>> GetAll<T>(Uri uri)
{
Expand All @@ -139,7 +139,7 @@ public Task<IReadOnlyList<T>> GetAll<T>(Uri uri)
/// <typeparam name="T">Type of the API resource in the list.</typeparam>
/// <param name="uri">URI of the API resource to get</param>
/// <param name="options">Options for changing the API response</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, ApiOptions options)
{
Expand All @@ -152,7 +152,7 @@ public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, ApiOptions options)
/// <typeparam name="T">Type of the API resource in the list.</typeparam>
/// <param name="uri">URI of the API resource to get</param>
/// <param name="parameters">Parameters to add to the API request</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, IDictionary<string, string> parameters)
{
Expand All @@ -165,7 +165,7 @@ public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, IDictionary<string, string> par
/// <typeparam name="T">Type of the API resource in the list.</typeparam>
/// <param name="uri">URI of the API resource to get</param>
/// <param name="accepts">Accept header to use for the API request</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, string accepts)
{
Expand All @@ -179,7 +179,7 @@ public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, string accepts)
/// <param name="uri">URI of the API resource to get</param>
/// <param name="parameters">Parameters to add to the API request</param>
/// <param name="options">Options for changing the API response</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, IDictionary<string, string> parameters, ApiOptions options)
{
Expand All @@ -193,7 +193,7 @@ public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, IDictionary<string, string> par
/// <param name="uri">URI of the API resource to get</param>
/// <param name="parameters">Parameters to add to the API request</param>
/// <param name="accepts">Accept header to use for the API request</param>
/// <returns><see cref="IReadOnlyList{T}"/> of the The API resources in the list.</returns>
/// <returns><see cref="IReadOnlyList{T}"/> of the API resources in the list.</returns>
/// <exception cref="ApiException">Thrown when an API error occurs.</exception>
public Task<IReadOnlyList<T>> GetAll<T>(Uri uri, IDictionary<string, string> parameters, string accepts)
{
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Http/ApiInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace Octokit
{
/// <summary>
/// Extra information returned as part of each api response.
/// Extra information returned as part of each API response.
/// </summary>
public class ApiInfo
{
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Http/HttpClientAdapter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ protected virtual void Dispose(bool disposing)

public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
// Clone the request/content incase we get a redirect
// Clone the request/content in case we get a redirect
var clonedRequest = await CloneHttpRequestMessageAsync(request).ConfigureAwait(false);

// Send initial response
Expand Down
4 changes: 2 additions & 2 deletions Octokit/Http/Response.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ namespace Octokit.Internal
/// </summary>
internal class Response : IResponse
{
[Obsolete("Use the constuctor with maximum parameters to avoid shortcuts")]
[Obsolete("Use the constructor with maximum parameters to avoid shortcuts")]
public Response() : this(new Dictionary<string, string>())
{
}

[Obsolete("Use the constuctor with maximum parameters to avoid shortcuts")]
[Obsolete("Use the constructor with maximum parameters to avoid shortcuts")]
public Response(IDictionary<string, string> headers)
{
Ensure.ArgumentNotNull(headers, nameof(headers));
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Request/IssueUpdate.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ internal string DebuggerDisplay
}

/// <summary>
/// Adds the specified assigness to the issue.
/// Adds the specified assignees to the issue.
/// </summary>
/// <param name="name">The login of the assignee.</param>
public void AddAssignee(string name)
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Request/NewArbitraryMarkDown.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace Octokit
{
/// <summary>
/// Used to create anarbitrary markdown
/// Used to create an arbitrary markdown
/// </summary>
/// <remarks>
/// API: https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Request/NewRepository.cs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public NewRepository(string name)
public string GitignoreTemplate { get; set; }

/// <summary>
/// Optional. Gets or sets the desired Desired LICENSE template to apply. Use the name of the template without
/// Optional. Gets or sets the desired LICENSE template to apply. Use the name of the template without
/// the extension. For example, “mit” or “mozilla”.
/// </summary>
/// <remarks>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Request/NewTreeItem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public class NewTreeItem
public string Sha { get; set; }

/// <summary>
/// Gets or sets the The content you want this file to have. GitHub will write this blob out and use that SHA
/// Gets or sets the content you want this file to have. GitHub will write this blob out and use that SHA
/// for this entry. Use either this, or tree.sha.
/// </summary>
/// <value>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Request/SearchRepositoriesRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ public enum InQualifier
}

/// <summary>
/// Helper class in generating the range values for a qualifer e.g. In or Size qualifiers
/// Helper class in generating the range values for a qualifier e.g. In or Size qualifiers
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class Range
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/Account.cs
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ protected Account(string avatarUrl, string bio, string blog, int collaborators,
/// <summary>
/// Indicates whether the account is currently hireable.
/// </summary>
/// <value>True if the account is hirable; otherwise, false.</value>
/// <value>True if the account is hireable; otherwise, false.</value>
public bool? Hireable { get; protected set; }

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/Author.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public Author(string login, int id, string nodeId, string avatarUrl, string url,

public string ReceivedEventsUrl { get; protected set; }

[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods", Justification = "This is what is returned from the api")]
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods", Justification = "This is what is returned from the API")]
public string Type { get; protected set; }

public bool SiteAdmin { get; protected set; }
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/CheckRun.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public CheckRun(long id, string headSha, string externalId, string url, string h
public string ExternalId { get; protected set; }

/// <summary>
/// The GitHub Api URL of the check run
/// The GitHub API URL of the check run
/// </summary>
public string Url { get; protected set; }

Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/CheckSuite.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public CheckSuite(long id, string headBranch, string headSha, CheckStatus status
public StringEnum<CheckConclusion>? Conclusion { get; protected set; }

/// <summary>
/// The GitHub Api URL of the check suite
/// The GitHub API URL of the check suite
/// </summary>
public string Url { get; protected set; }

Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/PullRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ public bool Merged

/// <summary>
/// The value of this field changes depending on the state of the pull request.
/// Not Merged - the hash of the test commit used to determine mergability.
/// Not Merged - the hash of the test commit used to determine mergeability.
/// Merged with merge commit - the hash of said merge commit.
/// Merged via squashing - the hash of the squashed commit added to the base branch.
/// Merged via rebase - the hash of the commit that the base branch was updated to.
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/UserRenameResponse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public UserRenameResponse(string message, string url)
}

/// <summary>
/// Message indiating if the Rename request was queued
/// Message indicating if the Rename request was queued
/// </summary>
public string Message { get; protected set; }

Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/Verification.cs
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public enum VerificationReason
[Parameter(Value = "malformed_signature")]
MalformedSignature,

[Parameter(Value = "inavlid")]
[Parameter(Value = "invalid")]
Invalid,

[Parameter(Value = "valid")]
Expand Down
Loading

0 comments on commit 66a6781

Please sign in to comment.