diff --git a/Octokit/Clients/ICheckSuitesClient.cs b/Octokit/Clients/ICheckSuitesClient.cs index cb95dce352..22b9f0f8be 100644 --- a/Octokit/Clients/ICheckSuitesClient.cs +++ b/Octokit/Clients/ICheckSuitesClient.cs @@ -102,7 +102,7 @@ public interface ICheckSuitesClient Task GetAllForReference(long repositoryId, string reference, CheckSuiteRequest request, ApiOptions options); /// - /// 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 /// /// /// See the Check Suites API documentation for more information. @@ -113,7 +113,7 @@ public interface ICheckSuitesClient Task UpdatePreferences(string owner, string name, CheckSuitePreferences preferences); /// - /// 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 /// /// /// See the Check Suites API documentation for more information. diff --git a/Octokit/Clients/IRepositoryInvitationsClient.cs b/Octokit/Clients/IRepositoryInvitationsClient.cs index d733471483..9295cfffd6 100644 --- a/Octokit/Clients/IRepositoryInvitationsClient.cs +++ b/Octokit/Clients/IRepositoryInvitationsClient.cs @@ -93,7 +93,7 @@ public interface IRepositoryInvitationsClient /// /// The id of the repository /// The id of the invitation - /// The permission for the collsborator + /// The permission for the collaborator /// Thrown when a general API error occurs. Task Edit(long repositoryId, int invitationId, InvitationUpdate permissions); } diff --git a/Octokit/Clients/MigrationsClient.cs b/Octokit/Clients/MigrationsClient.cs index efef5ba0ad..4f5a0e2d07 100644 --- a/Octokit/Clients/MigrationsClient.cs +++ b/Octokit/Clients/MigrationsClient.cs @@ -43,7 +43,7 @@ public async Task Start(string org, StartMigrationRequest migration) } /// - /// Gets the list of the most recent migrations of the the organization. + /// Gets the list of the most recent migrations of the organization. /// /// /// https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations @@ -57,7 +57,7 @@ public async Task> GetAll(string org) } /// - /// Gets the list of the most recent migrations of the the organization. + /// Gets the list of the most recent migrations of the organization. /// /// /// https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations diff --git a/Octokit/Clients/RepositoryInvitationsClient.cs b/Octokit/Clients/RepositoryInvitationsClient.cs index a0d495f486..0a4261d5ce 100644 --- a/Octokit/Clients/RepositoryInvitationsClient.cs +++ b/Octokit/Clients/RepositoryInvitationsClient.cs @@ -151,7 +151,7 @@ public Task> GetAllForRepository(long reposi /// /// The id of the repository /// The id of the invitation - /// The permission for the collsborator + /// The permission for the collaborator /// Thrown when a general API error occurs. [ManualRoute("PATCH", "/repositories/{id}/invitations/{invitation_id}")] public Task Edit(long repositoryId, int invitationId, InvitationUpdate permissions) diff --git a/Octokit/Clients/UserGpgKeysClient.cs b/Octokit/Clients/UserGpgKeysClient.cs index fae9436f86..f2d859e6bf 100644 --- a/Octokit/Clients/UserGpgKeysClient.cs +++ b/Octokit/Clients/UserGpgKeysClient.cs @@ -14,7 +14,7 @@ namespace Octokit public class UserGpgKeysClient : ApiClient, IUserGpgKeysClient { /// - /// Instatiates a new GitHub User GPG Keys API client. + /// Instantiates a new GitHub User GPG Keys API client. /// /// The API connection. public UserGpgKeysClient(IApiConnection apiConnection) : base(apiConnection) diff --git a/Octokit/Clients/UserKeysClient.cs b/Octokit/Clients/UserKeysClient.cs index 5985a11eea..d9e9b30f8e 100644 --- a/Octokit/Clients/UserKeysClient.cs +++ b/Octokit/Clients/UserKeysClient.cs @@ -69,7 +69,7 @@ public Task> GetAllForCurrent() /// /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// - /// Options to chagne API's behavior. + /// Options to change API's behavior. /// Lists the current user's keys. [ManualRoute("GET", "/user/keys")] public Task> GetAllForCurrent(ApiOptions options) diff --git a/Octokit/Exceptions/RateLimitExceededException.cs b/Octokit/Exceptions/RateLimitExceededException.cs index 8496e67b13..537d9c82d1 100644 --- a/Octokit/Exceptions/RateLimitExceededException.cs +++ b/Octokit/Exceptions/RateLimitExceededException.cs @@ -93,7 +93,7 @@ public override string Message /// /// 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. /// public TimeSpan GetRetryAfterTimeSpan() { diff --git a/Octokit/Helpers/ApiExtensions.cs b/Octokit/Helpers/ApiExtensions.cs index ffc8d978fc..7cd04ab9ca 100644 --- a/Octokit/Helpers/ApiExtensions.cs +++ b/Octokit/Helpers/ApiExtensions.cs @@ -17,7 +17,7 @@ public static class ApiExtensions /// Type of the API resource in the list. /// The connection to use /// URI of the API resource to get - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public static Task> GetAll(this IApiConnection connection, Uri uri) { diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs index be3a06c289..252eedcc61 100644 --- a/Octokit/Helpers/ApiUrls.cs +++ b/Octokit/Helpers/ApiUrls.cs @@ -3714,7 +3714,7 @@ public static Uri UserInvitations(int invitationId) } /// - /// Returns the for repository traffice referrers. + /// Returns the for repository traffic referrers. /// /// The owner of repo /// The name of repo diff --git a/Octokit/Http/ApiConnection.cs b/Octokit/Http/ApiConnection.cs index dd3cc04102..5a477db6e0 100644 --- a/Octokit/Http/ApiConnection.cs +++ b/Octokit/Http/ApiConnection.cs @@ -28,7 +28,7 @@ public class ApiConnection : IApiConnection /// Initializes a new instance of the class. /// /// A connection for making HTTP requests - /// A paginator for paging API responses + /// A pagination for paging API responses protected ApiConnection(IConnection connection, IApiPagination pagination) { Ensure.ArgumentNotNull(connection, nameof(connection)); @@ -126,7 +126,7 @@ public async Task GetRaw(Uri uri, IDictionary parameters /// /// Type of the API resource in the list. /// URI of the API resource to get - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri) { @@ -139,7 +139,7 @@ public Task> GetAll(Uri uri) /// Type of the API resource in the list. /// URI of the API resource to get /// Options for changing the API response - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, ApiOptions options) { @@ -152,7 +152,7 @@ public Task> GetAll(Uri uri, ApiOptions options) /// Type of the API resource in the list. /// URI of the API resource to get /// Parameters to add to the API request - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, IDictionary parameters) { @@ -165,7 +165,7 @@ public Task> GetAll(Uri uri, IDictionary par /// Type of the API resource in the list. /// URI of the API resource to get /// Accept header to use for the API request - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, string accepts) { @@ -179,7 +179,7 @@ public Task> GetAll(Uri uri, string accepts) /// URI of the API resource to get /// Parameters to add to the API request /// Options for changing the API response - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, IDictionary parameters, ApiOptions options) { @@ -193,7 +193,7 @@ public Task> GetAll(Uri uri, IDictionary par /// URI of the API resource to get /// Parameters to add to the API request /// Accept header to use for the API request - /// of the The API resources in the list. + /// of the API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, IDictionary parameters, string accepts) { diff --git a/Octokit/Http/ApiInfo.cs b/Octokit/Http/ApiInfo.cs index 1958c34b5c..1ff348d85f 100644 --- a/Octokit/Http/ApiInfo.cs +++ b/Octokit/Http/ApiInfo.cs @@ -5,7 +5,7 @@ namespace Octokit { /// - /// Extra information returned as part of each api response. + /// Extra information returned as part of each API response. /// public class ApiInfo { diff --git a/Octokit/Http/HttpClientAdapter.cs b/Octokit/Http/HttpClientAdapter.cs index 6a870ebf3a..efe823dda5 100644 --- a/Octokit/Http/HttpClientAdapter.cs +++ b/Octokit/Http/HttpClientAdapter.cs @@ -213,7 +213,7 @@ protected virtual void Dispose(bool disposing) public async Task 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 diff --git a/Octokit/Http/Response.cs b/Octokit/Http/Response.cs index d023a34aa4..49c99912db 100644 --- a/Octokit/Http/Response.cs +++ b/Octokit/Http/Response.cs @@ -10,12 +10,12 @@ namespace Octokit.Internal /// 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()) { } - [Obsolete("Use the constuctor with maximum parameters to avoid shortcuts")] + [Obsolete("Use the constructor with maximum parameters to avoid shortcuts")] public Response(IDictionary headers) { Ensure.ArgumentNotNull(headers, nameof(headers)); diff --git a/Octokit/Models/Request/IssueUpdate.cs b/Octokit/Models/Request/IssueUpdate.cs index 7669abe1b1..8837e1e32a 100644 --- a/Octokit/Models/Request/IssueUpdate.cs +++ b/Octokit/Models/Request/IssueUpdate.cs @@ -62,7 +62,7 @@ internal string DebuggerDisplay } /// - /// Adds the specified assigness to the issue. + /// Adds the specified assignees to the issue. /// /// The login of the assignee. public void AddAssignee(string name) diff --git a/Octokit/Models/Request/NewArbitraryMarkDown.cs b/Octokit/Models/Request/NewArbitraryMarkDown.cs index 763440fb67..c40b144368 100644 --- a/Octokit/Models/Request/NewArbitraryMarkDown.cs +++ b/Octokit/Models/Request/NewArbitraryMarkDown.cs @@ -5,7 +5,7 @@ namespace Octokit { /// - /// Used to create anarbitrary markdown + /// Used to create an arbitrary markdown /// /// /// API: https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document diff --git a/Octokit/Models/Request/NewRepository.cs b/Octokit/Models/Request/NewRepository.cs index 15ac1d7700..a081fd4eae 100644 --- a/Octokit/Models/Request/NewRepository.cs +++ b/Octokit/Models/Request/NewRepository.cs @@ -58,7 +58,7 @@ public NewRepository(string name) public string GitignoreTemplate { get; set; } /// - /// 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”. /// /// diff --git a/Octokit/Models/Request/NewTreeItem.cs b/Octokit/Models/Request/NewTreeItem.cs index 4a8a529e8b..738b21c546 100644 --- a/Octokit/Models/Request/NewTreeItem.cs +++ b/Octokit/Models/Request/NewTreeItem.cs @@ -35,7 +35,7 @@ public class NewTreeItem public string Sha { get; set; } /// - /// 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. /// /// diff --git a/Octokit/Models/Request/SearchRepositoriesRequest.cs b/Octokit/Models/Request/SearchRepositoriesRequest.cs index f674fa9168..d888f4f00a 100644 --- a/Octokit/Models/Request/SearchRepositoriesRequest.cs +++ b/Octokit/Models/Request/SearchRepositoriesRequest.cs @@ -201,7 +201,7 @@ public enum InQualifier } /// - /// 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 /// [DebuggerDisplay("{DebuggerDisplay,nq}")] public class Range diff --git a/Octokit/Models/Response/Account.cs b/Octokit/Models/Response/Account.cs index ce508c6b28..0f18fac7ab 100644 --- a/Octokit/Models/Response/Account.cs +++ b/Octokit/Models/Response/Account.cs @@ -91,7 +91,7 @@ protected Account(string avatarUrl, string bio, string blog, int collaborators, /// /// Indicates whether the account is currently hireable. /// - /// True if the account is hirable; otherwise, false. + /// True if the account is hireable; otherwise, false. public bool? Hireable { get; protected set; } /// diff --git a/Octokit/Models/Response/Author.cs b/Octokit/Models/Response/Author.cs index c37ee6a6e8..95e1e93000 100644 --- a/Octokit/Models/Response/Author.cs +++ b/Octokit/Models/Response/Author.cs @@ -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; } diff --git a/Octokit/Models/Response/CheckRun.cs b/Octokit/Models/Response/CheckRun.cs index 6642e61a1b..d2a58f1442 100644 --- a/Octokit/Models/Response/CheckRun.cs +++ b/Octokit/Models/Response/CheckRun.cs @@ -46,7 +46,7 @@ public CheckRun(long id, string headSha, string externalId, string url, string h public string ExternalId { get; protected set; } /// - /// The GitHub Api URL of the check run + /// The GitHub API URL of the check run /// public string Url { get; protected set; } diff --git a/Octokit/Models/Response/CheckSuite.cs b/Octokit/Models/Response/CheckSuite.cs index ecfdb3ce95..8c7350c5da 100644 --- a/Octokit/Models/Response/CheckSuite.cs +++ b/Octokit/Models/Response/CheckSuite.cs @@ -52,7 +52,7 @@ public CheckSuite(long id, string headBranch, string headSha, CheckStatus status public StringEnum? Conclusion { get; protected set; } /// - /// The GitHub Api URL of the check suite + /// The GitHub API URL of the check suite /// public string Url { get; protected set; } diff --git a/Octokit/Models/Response/PullRequest.cs b/Octokit/Models/Response/PullRequest.cs index 8acce69c69..ff90a59a2b 100644 --- a/Octokit/Models/Response/PullRequest.cs +++ b/Octokit/Models/Response/PullRequest.cs @@ -197,7 +197,7 @@ public bool Merged /// /// 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. diff --git a/Octokit/Models/Response/UserRenameResponse.cs b/Octokit/Models/Response/UserRenameResponse.cs index 9fe0c8a6fe..d416adbae5 100644 --- a/Octokit/Models/Response/UserRenameResponse.cs +++ b/Octokit/Models/Response/UserRenameResponse.cs @@ -18,7 +18,7 @@ public UserRenameResponse(string message, string url) } /// - /// Message indiating if the Rename request was queued + /// Message indicating if the Rename request was queued /// public string Message { get; protected set; } diff --git a/Octokit/Models/Response/Verification.cs b/Octokit/Models/Response/Verification.cs index 109b3c9a6b..03695fba5a 100644 --- a/Octokit/Models/Response/Verification.cs +++ b/Octokit/Models/Response/Verification.cs @@ -91,7 +91,7 @@ public enum VerificationReason [Parameter(Value = "malformed_signature")] MalformedSignature, - [Parameter(Value = "inavlid")] + [Parameter(Value = "invalid")] Invalid, [Parameter(Value = "valid")] diff --git a/Octokit/SimpleJson.cs b/Octokit/SimpleJson.cs index 8ee637b06a..5d5161c202 100644 --- a/Octokit/SimpleJson.cs +++ b/Octokit/SimpleJson.cs @@ -355,7 +355,7 @@ public override string ToString() /// Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion. /// The result of the type conversion operation. /// - /// Alwasy returns true. + /// Always returns true. /// public override bool TryConvert(ConvertBinder binder, out object result) { @@ -382,7 +382,7 @@ public override bool TryConvert(ConvertBinder binder, out object result) /// /// Provides information about the deletion. /// - /// Alwasy returns true. + /// Always returns true. /// public override bool TryDeleteMember(DeleteMemberBinder binder) { @@ -400,7 +400,7 @@ public override bool TryDeleteMember(DeleteMemberBinder binder) /// The indexes that are used in the operation. For example, for the sampleObject[3] operation in C# (sampleObject(3) in Visual Basic), where sampleObject is derived from the DynamicObject class, is equal to 3. /// The result of the index operation. /// - /// Alwasy returns true. + /// Always returns true. /// public override bool TryGetIndex(GetIndexBinder binder, object[] indexes, out object result) { @@ -420,7 +420,7 @@ public override bool TryGetIndex(GetIndexBinder binder, object[] indexes, out ob /// Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive. /// The result of the get operation. For example, if the method is called for a property, you can assign the property value to . /// - /// Alwasy returns true. + /// Always returns true. /// public override bool TryGetMember(GetMemberBinder binder, out object result) { @@ -493,7 +493,7 @@ namespace Octokit /// This class encodes and decodes JSON strings. /// Spec. details, see http://www.json.org/ /// - /// JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). + /// JSON uses Arrays and Objects. These correspond here to the data types JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). /// All numbers are parsed to doubles. /// [GeneratedCode("simple-json", "1.0.0")]