diff --git a/Octokit.Reactive/Clients/IObservableCheckSuitesClient.cs b/Octokit.Reactive/Clients/IObservableCheckSuitesClient.cs index a40f3853c6..25a2ecc9ec 100644 --- a/Octokit.Reactive/Clients/IObservableCheckSuitesClient.cs +++ b/Octokit.Reactive/Clients/IObservableCheckSuitesClient.cs @@ -101,7 +101,7 @@ public interface IObservableCheckSuitesClient IObservable 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. @@ -112,7 +112,7 @@ public interface IObservableCheckSuitesClient IObservable 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.Reactive/Clients/IObservableMigrationsClient.cs b/Octokit.Reactive/Clients/IObservableMigrationsClient.cs index f95c7861bd..ad44792252 100644 --- a/Octokit.Reactive/Clients/IObservableMigrationsClient.cs +++ b/Octokit.Reactive/Clients/IObservableMigrationsClient.cs @@ -21,7 +21,7 @@ public interface IObservableMigrationsClient /// https://developer.github.com/v3/migration/migrations/#start-a-migration /// /// The organization for which to start a migration. - /// Sprcifies parameters for the migration in a + /// Specifies parameters for the migration in a /// object. /// The started migration. IObservable Start( @@ -29,7 +29,7 @@ IObservable Start( 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 @@ -40,7 +40,7 @@ IObservable 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.Reactive/Clients/IObservableMiscellaneousClient.cs b/Octokit.Reactive/Clients/IObservableMiscellaneousClient.cs index 25d63bc45f..4fbf18eb66 100644 --- a/Octokit.Reactive/Clients/IObservableMiscellaneousClient.cs +++ b/Octokit.Reactive/Clients/IObservableMiscellaneousClient.cs @@ -53,7 +53,7 @@ public interface IObservableMiscellaneousClient IObservable GetAllLicenses(); /// - /// Retrieves a license based on the license key such as "mit" + /// Retrieves a license based on the license key such as "MIT" /// /// /// A that includes the license key, text, and attributes of the license. diff --git a/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs b/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs index be15d932d8..4d0201706b 100644 --- a/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs +++ b/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs @@ -265,7 +265,7 @@ public interface IObservableOrganizationMembersClient /// Make the authenticated user's organization membership private. /// /// - /// This method requries authentication. + /// This method requires authentication. /// See the API documentation /// for more information. /// diff --git a/Octokit.Reactive/Clients/IObservableProjectsClient.cs b/Octokit.Reactive/Clients/IObservableProjectsClient.cs index 2172e0868f..19669b426d 100644 --- a/Octokit.Reactive/Clients/IObservableProjectsClient.cs +++ b/Octokit.Reactive/Clients/IObservableProjectsClient.cs @@ -101,7 +101,7 @@ public interface IObservableProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization IObservable GetAllForOrganization(string organization); /// @@ -110,7 +110,7 @@ public interface IObservableProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned IObservable GetAllForOrganization(string organization, ProjectRequest request); @@ -120,7 +120,7 @@ public interface IObservableProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Options for changing the API response IObservable GetAllForOrganization(string organization, ApiOptions options); @@ -130,7 +130,7 @@ public interface IObservableProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned /// Options for changing the API response IObservable GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options); diff --git a/Octokit.Reactive/Clients/IObservableTagsClient.cs b/Octokit.Reactive/Clients/IObservableTagsClient.cs index 27aca4267b..e2d262f8f4 100644 --- a/Octokit.Reactive/Clients/IObservableTagsClient.cs +++ b/Octokit.Reactive/Clients/IObservableTagsClient.cs @@ -19,7 +19,7 @@ public interface IObservableTagsClient /// /// The owner of the repository /// The name of the repository - /// Tha sha reference of the tag + /// The sha reference of the tag [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] IObservable Get(string owner, string name, string reference); @@ -31,7 +31,7 @@ public interface IObservableTagsClient /// http://developer.github.com/v3/git/tags/#get-a-tag /// /// The Id of the repository - /// Tha sha reference of the tag + /// The sha reference of the tag [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] IObservable Get(long repositoryId, string reference); diff --git a/Octokit.Reactive/Clients/ObservableMiscellaneousClient.cs b/Octokit.Reactive/Clients/ObservableMiscellaneousClient.cs index 0795360b15..8bd20c67c0 100644 --- a/Octokit.Reactive/Clients/ObservableMiscellaneousClient.cs +++ b/Octokit.Reactive/Clients/ObservableMiscellaneousClient.cs @@ -78,7 +78,7 @@ public IObservable GetAllLicenses() } /// - /// Retrieves a license based on the license key such as "mit" + /// Retrieves a license based on the license key such as "MIT" /// /// /// A that includes the license key, text, and attributes of the license. diff --git a/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs b/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs index 7ed4487a49..064403740b 100644 --- a/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs +++ b/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs @@ -361,7 +361,7 @@ public IObservable Publicize(string org, string user) /// Make the authenticated user's organization membership private. /// /// - /// This method requries authentication. + /// This method requires authentication. /// See the API documentation /// for more information. /// diff --git a/Octokit.Reactive/Clients/ObservableProjectsClient.cs b/Octokit.Reactive/Clients/ObservableProjectsClient.cs index 377092d7b6..76d7195400 100644 --- a/Octokit.Reactive/Clients/ObservableProjectsClient.cs +++ b/Octokit.Reactive/Clients/ObservableProjectsClient.cs @@ -175,7 +175,7 @@ public IObservable GetAllForOrganization(string organization) /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Options for changing the API response public IObservable GetAllForOrganization(string organization, ApiOptions options) { @@ -193,7 +193,7 @@ public IObservable GetAllForOrganization(string organization, ApiOption /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned public IObservable GetAllForOrganization(string organization, ProjectRequest request) { @@ -206,7 +206,7 @@ public IObservable GetAllForOrganization(string organization, ProjectRe /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned /// Options for changing the API response public IObservable GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options) diff --git a/Octokit.Reactive/Clients/ObservableSearchClient.cs b/Octokit.Reactive/Clients/ObservableSearchClient.cs index 9f9b2c7f32..ff40d5817e 100644 --- a/Octokit.Reactive/Clients/ObservableSearchClient.cs +++ b/Octokit.Reactive/Clients/ObservableSearchClient.cs @@ -4,7 +4,7 @@ namespace Octokit.Reactive { /// - /// GitHub Search Api Client + /// GitHub Search API Client /// public class ObservableSearchClient : IObservableSearchClient { diff --git a/Octokit/Clients/CheckSuitesClient.cs b/Octokit/Clients/CheckSuitesClient.cs index 71affd3375..26275dc0ce 100644 --- a/Octokit/Clients/CheckSuitesClient.cs +++ b/Octokit/Clients/CheckSuitesClient.cs @@ -171,7 +171,7 @@ public async Task GetAllForReference(long repositoryId, str } /// - /// 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. @@ -189,7 +189,7 @@ public Task UpdatePreferences(string owner, strin } /// - /// 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/IMigrationsClient.cs b/Octokit/Clients/IMigrationsClient.cs index 7e9cca5bda..cbc6de80f7 100644 --- a/Octokit/Clients/IMigrationsClient.cs +++ b/Octokit/Clients/IMigrationsClient.cs @@ -20,7 +20,7 @@ public interface IMigrationsClient /// https://developer.github.com/v3/migration/migrations/#start-a-migration /// /// The organization for which to start a migration. - /// Sprcifies parameters for the migration in a + /// Specifies parameters for the migration in a /// object. /// The started migration. Task Start( @@ -28,7 +28,7 @@ Task Start( 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 @@ -39,7 +39,7 @@ 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/IMiscellaneousClient.cs b/Octokit/Clients/IMiscellaneousClient.cs index 78cb2e9e56..0f6ae3073f 100644 --- a/Octokit/Clients/IMiscellaneousClient.cs +++ b/Octokit/Clients/IMiscellaneousClient.cs @@ -63,7 +63,7 @@ public interface IMiscellaneousClient Task> GetAllLicenses(); /// - /// Retrieves a license based on the license key such as "mit" + /// Retrieves a license based on the license key such as "MIT" /// /// /// A that includes the license key, text, and attributes of the license. diff --git a/Octokit/Clients/IProjectsClient.cs b/Octokit/Clients/IProjectsClient.cs index 3e75e2f35f..5a56a406d6 100644 --- a/Octokit/Clients/IProjectsClient.cs +++ b/Octokit/Clients/IProjectsClient.cs @@ -102,7 +102,7 @@ public interface IProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization Task> GetAllForOrganization(string organization); /// @@ -111,7 +111,7 @@ public interface IProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned Task> GetAllForOrganization(string organization, ProjectRequest request); @@ -121,7 +121,7 @@ public interface IProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Options for changing the API response Task> GetAllForOrganization(string organization, ApiOptions options); @@ -131,7 +131,7 @@ public interface IProjectsClient /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned /// Options for changing the API response Task> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options); diff --git a/Octokit/Clients/ProjectsClient.cs b/Octokit/Clients/ProjectsClient.cs index 5afd714461..6487c3a3ea 100644 --- a/Octokit/Clients/ProjectsClient.cs +++ b/Octokit/Clients/ProjectsClient.cs @@ -148,7 +148,7 @@ public Task> GetAllForRepository(long repositoryId, Proje /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization public Task> GetAllForOrganization(string organization) { return GetAllForOrganization(organization, ApiOptions.None); @@ -160,7 +160,7 @@ public Task> GetAllForOrganization(string organization) /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Options for changing the API response public Task> GetAllForOrganization(string organization, ApiOptions options) { @@ -177,7 +177,7 @@ public Task> GetAllForOrganization(string organization, A /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned public Task> GetAllForOrganization(string organization, ProjectRequest request) { @@ -193,7 +193,7 @@ public Task> GetAllForOrganization(string organization, P /// /// See the API documentation for more information. /// - /// The name of the organziation + /// The name of the organization /// Used to filter the list of projects returned /// Options for changing the API response public Task> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options) diff --git a/Octokit/Exceptions/AbuseException.cs b/Octokit/Exceptions/AbuseException.cs index 624559e95a..8fceec4f3a 100644 --- a/Octokit/Exceptions/AbuseException.cs +++ b/Octokit/Exceptions/AbuseException.cs @@ -11,7 +11,7 @@ namespace Octokit { /// /// Represents a subset of the HTTP 403 - Forbidden response returned from the API when the forbidden response is related to an abuse detection mechanism. - /// Containts the amount of seconds after which it's safe to retry the request. + /// Contains the amount of seconds after which it's safe to retry the request. /// #if !NO_SERIALIZABLE [Serializable] diff --git a/Octokit/Exceptions/ApiException.cs b/Octokit/Exceptions/ApiException.cs index d7b49d8540..4dd08d27e4 100644 --- a/Octokit/Exceptions/ApiException.cs +++ b/Octokit/Exceptions/ApiException.cs @@ -109,7 +109,7 @@ public override string Message } /// - /// The HTTP status code associated with the repsonse + /// The HTTP status code associated with the response /// public HttpStatusCode StatusCode { get; private set; } diff --git a/Octokit/Exceptions/PullRequestMismatchException.cs b/Octokit/Exceptions/PullRequestMismatchException.cs index f94ab78c96..83df68cc66 100644 --- a/Octokit/Exceptions/PullRequestMismatchException.cs +++ b/Octokit/Exceptions/PullRequestMismatchException.cs @@ -20,7 +20,7 @@ namespace Octokit public class PullRequestMismatchException : ApiException { /// - /// Constructs an instace of . + /// Constructs an instance of . /// /// public PullRequestMismatchException(IResponse response) : this(response, null) diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs index 06f050f8e5..7c82bb05d5 100644 --- a/Octokit/Helpers/ApiUrls.cs +++ b/Octokit/Helpers/ApiUrls.cs @@ -374,7 +374,7 @@ public static Uri UserInstallations() } /// - /// Returns the that returns all the repositores + /// Returns the that returns all the repositories /// /// public static Uri InstallationRepositories() @@ -622,7 +622,7 @@ public static Uri Assignees(string owner, string name) /// /// Returns the that returns a 204 if the login belongs to an assignee of the repository. - /// Otherwire returns a 404. + /// Otherwise returns a 404. /// /// The owner of the repository /// The name of the repository @@ -1277,7 +1277,7 @@ public static Uri PullRequestFiles(string owner, string name, int number) } /// - /// Returns the for a spesific comment for the specified commit. + /// Returns the for a specific comment for the specified commit. /// /// The id of the gist /// The id of the comment @@ -2710,11 +2710,11 @@ public static Uri Blob(long repositoryId, string reference) } /// - /// Returns the that returns a 204 if the login belongs to an assignee of the repository. Otherwire returns a 404. + /// Returns the that returns a 204 if the login belongs to an assignee of the repository. Otherwise returns a 404. /// /// The Id of the repository /// The login for the user - /// The that returns a 204 if the login belongs to an assignee of the repository. Otherwire returns a 404. + /// The that returns a 204 if the login belongs to an assignee of the repository. Otherwise returns a 404. public static Uri CheckAssignee(long repositoryId, string login) { return "repositories/{0}/assignees/{1}".FormatUri(repositoryId, login); @@ -3693,7 +3693,7 @@ public static Uri RepositoryTrafficReferrers(string owner, string repo) } /// - /// Returns the for repository traffice referrers. + /// Returns the for repository traffic referrers. /// /// The id of the repository /// The for repository traffic referrers. @@ -3703,7 +3703,7 @@ public static Uri RepositoryTrafficReferrers(long repositoryId) } /// - /// Returns the for repository traffice paths. + /// Returns the for repository traffic paths. /// /// The owner of repo /// The name of repo @@ -3714,7 +3714,7 @@ public static Uri RepositoryTrafficPaths(string owner, string repo) } /// - /// Returns the for repository traffice paths. + /// Returns the for repository traffic paths. /// /// The id of the repository /// The for repository traffic paths. @@ -3724,7 +3724,7 @@ public static Uri RepositoryTrafficPaths(long repositoryId) } /// - /// Returns the for repository traffice views. + /// Returns the for repository traffic views. /// /// The owner of repo /// The name of repo @@ -3735,7 +3735,7 @@ public static Uri RepositoryTrafficViews(string owner, string repo) } /// - /// Returns the for repository traffice views. + /// Returns the for repository traffic views. /// /// The id of the repository /// The for repository traffic views. @@ -3745,7 +3745,7 @@ public static Uri RepositoryTrafficViews(long repositoryId) } /// - /// Returns the for repository traffice clones. + /// Returns the for repository traffic clones. /// /// The owner of repo /// The name of repo @@ -3756,7 +3756,7 @@ public static Uri RepositoryTrafficClones(string owner, string repo) } /// - /// Returns the for repository traffice clones. + /// Returns the for repository traffic clones. /// /// The id of the repository /// The for repository traffic clones. diff --git a/Octokit/Http/IApiConnection.cs b/Octokit/Http/IApiConnection.cs index 4dd711562b..616dbfead0 100644 --- a/Octokit/Http/IApiConnection.cs +++ b/Octokit/Http/IApiConnection.cs @@ -67,7 +67,7 @@ public interface IApiConnection /// /// 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. Task> GetAll(Uri uri); @@ -77,7 +77,7 @@ public interface IApiConnection /// 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. Task> GetAll(Uri uri, ApiOptions options); @@ -87,7 +87,7 @@ public interface IApiConnection /// 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. Task> GetAll(Uri uri, IDictionary parameters); @@ -97,7 +97,7 @@ public interface IApiConnection /// 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. Task> GetAll(Uri uri, string accepts); @@ -108,7 +108,7 @@ public interface IApiConnection /// 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. Task> GetAll(Uri uri, IDictionary parameters, ApiOptions options); @@ -119,7 +119,7 @@ public interface IApiConnection /// 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. Task> GetAll(Uri uri, IDictionary parameters, string accepts); @@ -131,7 +131,7 @@ public interface IApiConnection /// Parameters to add to the API request /// Accept header to use for 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. Task> GetAll(Uri uri, IDictionary parameters, string accepts, ApiOptions options); diff --git a/Octokit/Http/IApiInfoProvider.cs b/Octokit/Http/IApiInfoProvider.cs index 8221682ac3..7d51689613 100644 --- a/Octokit/Http/IApiInfoProvider.cs +++ b/Octokit/Http/IApiInfoProvider.cs @@ -8,7 +8,7 @@ public interface IApiInfoProvider /// /// Gets the latest API Info - this will be null if no API calls have been made /// - /// representing the information returned as part of an Api call + /// representing the information returned as part of an API call [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")] ApiInfo GetLastApiInfo(); } diff --git a/Octokit/Http/IHttpClient.cs b/Octokit/Http/IHttpClient.cs index 584bef9f79..bda7a0409f 100644 --- a/Octokit/Http/IHttpClient.cs +++ b/Octokit/Http/IHttpClient.cs @@ -22,7 +22,7 @@ public interface IHttpClient : IDisposable /// - /// Set the GitHub Api request timeout. + /// Set the GitHub API request timeout. /// /// The Timeout value void SetRequestTimeout(TimeSpan timeout); diff --git a/Octokit/Http/JsonHttpPipeline.cs b/Octokit/Http/JsonHttpPipeline.cs index 81548df58f..80830a9a30 100644 --- a/Octokit/Http/JsonHttpPipeline.cs +++ b/Octokit/Http/JsonHttpPipeline.cs @@ -54,7 +54,7 @@ public IApiResponse DeserializeResponse(IResponse response) var responseIsObject = body.StartsWith("{", StringComparison.Ordinal); // If we're expecting an array, but we get a single object, just wrap it. - // This supports an api that dynamically changes the return type based on the content. + // This supports an API that dynamically changes the return type based on the content. if (!typeIsDictionary && typeIsEnumerable && responseIsObject) { body = "[" + body + "]"; diff --git a/Octokit/Http/SimpleJsonSerializer.cs b/Octokit/Http/SimpleJsonSerializer.cs index dee7f87f62..319a343b5a 100644 --- a/Octokit/Http/SimpleJsonSerializer.cs +++ b/Octokit/Http/SimpleJsonSerializer.cs @@ -71,7 +71,7 @@ protected override bool TrySerializeUnknownTypes(object input, out object output if (ReflectionUtils.IsStringEnumWrapper(type)) { // Handle StringEnum by getting the underlying enum value, then using the enum serializer - // Note this will throw if the StringEnum was initialised using a string that is not a valid enum member + // Note this will throw if the StringEnum was initialized using a string that is not a valid enum member var inputEnum = (getters["value"](input) as Enum); if (inputEnum != null) { diff --git a/Octokit/IGitHubClient.cs b/Octokit/IGitHubClient.cs index 032536b634..d6aa599f8a 100644 --- a/Octokit/IGitHubClient.cs +++ b/Octokit/IGitHubClient.cs @@ -3,12 +3,12 @@ namespace Octokit { /// - /// A Client for the GitHub API v3. You can read more about the api here: http://developer.github.com. + /// A Client for the GitHub API v3. You can read more about the API here: http://developer.github.com. /// public interface IGitHubClient : IApiInfoProvider { /// - /// Set the GitHub Api request timeout. + /// Set the GitHub API request timeout. /// Useful to set a specific timeout for lengthy operations, such as uploading release assets /// /// diff --git a/Octokit/Models/Request/Enterprise/UpdateMaintenanceRequest.cs b/Octokit/Models/Request/Enterprise/UpdateMaintenanceRequest.cs index 4562138826..f1cc7abbb5 100644 --- a/Octokit/Models/Request/Enterprise/UpdateMaintenanceRequest.cs +++ b/Octokit/Models/Request/Enterprise/UpdateMaintenanceRequest.cs @@ -62,7 +62,7 @@ public UpdateMaintenanceRequestDetails(bool enabled) /// Maintenance request details to enable/disable maintenance at a specified time (only applicable when enabling maintenance) /// /// true to enable, false to disable - /// A phrase specifying when maintenance mode will be enabled. Phrase uses humanised forms supported by the mojombo/chronic library used by the GitHub API + /// A phrase specifying when maintenance mode will be enabled. Phrase uses humanized forms supported by the mojombo/chronic library used by the GitHub API /// such as "this friday at 5pm" or "5 minutes before midday tomorrow" /// If enabled is false, the when parameter is ignored and maintenance is turned off immediately public UpdateMaintenanceRequestDetails(bool enabled, string when) diff --git a/Octokit/Models/Request/NewDeployment.cs b/Octokit/Models/Request/NewDeployment.cs index 1e24f95cbe..b844ceffc1 100644 --- a/Octokit/Models/Request/NewDeployment.cs +++ b/Octokit/Models/Request/NewDeployment.cs @@ -96,7 +96,7 @@ internal string DebuggerDisplay } /// - /// The types of deployments tasks that are availabel. + /// The types of deployments tasks that are available. /// public enum DeployTask { diff --git a/Octokit/Models/Request/OrganizationRequest.cs b/Octokit/Models/Request/OrganizationRequest.cs index 7b51898b0d..2e73e2e970 100644 --- a/Octokit/Models/Request/OrganizationRequest.cs +++ b/Octokit/Models/Request/OrganizationRequest.cs @@ -10,7 +10,7 @@ namespace Octokit public class OrganizationRequest : RequestParameters { /// - /// Intializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The integer Id of the last Organization that you've seen. public OrganizationRequest(int since) diff --git a/Octokit/Models/Request/UpdateTeam.cs b/Octokit/Models/Request/UpdateTeam.cs index b23000072d..960019094d 100644 --- a/Octokit/Models/Request/UpdateTeam.cs +++ b/Octokit/Models/Request/UpdateTeam.cs @@ -5,7 +5,7 @@ namespace Octokit { /// - /// Used to update a teamm. + /// Used to update a team. /// [DebuggerDisplay("{DebuggerDisplay,nq}")] public class UpdateTeam diff --git a/Octokit/Models/Response/Account.cs b/Octokit/Models/Response/Account.cs index 9e242b9e9e..ce508c6b28 100644 --- a/Octokit/Models/Response/Account.cs +++ b/Octokit/Models/Response/Account.cs @@ -79,7 +79,7 @@ protected Account(string avatarUrl, string bio, string blog, int collaborators, public string Email { get; protected set; } /// - /// Number of follwers the account has. + /// Number of followers the account has. /// public int Followers { get; protected set; } diff --git a/Octokit/Models/Response/ApiError.cs b/Octokit/Models/Response/ApiError.cs index 609fb37b3b..be5650c9f6 100644 --- a/Octokit/Models/Response/ApiError.cs +++ b/Octokit/Models/Response/ApiError.cs @@ -6,7 +6,7 @@ namespace Octokit { /// - /// Error payload from the API reposnse + /// Error payload from the API response /// #if !NO_SERIALIZABLE [Serializable] diff --git a/Octokit/Models/Response/EventInfo.cs b/Octokit/Models/Response/EventInfo.cs index 060e8629f8..899b9b3a96 100644 --- a/Octokit/Models/Response/EventInfo.cs +++ b/Octokit/Models/Response/EventInfo.cs @@ -269,7 +269,7 @@ public enum EventInfoState Crossreferenced, /// - /// The issue was reveiewed. + /// The issue was reviewed. /// [Parameter(Value = "reviewed")] Reviewed, diff --git a/Octokit/Models/Response/Installation.cs b/Octokit/Models/Response/Installation.cs index 66ccaea8e9..83a7817a0c 100644 --- a/Octokit/Models/Response/Installation.cs +++ b/Octokit/Models/Response/Installation.cs @@ -65,7 +65,7 @@ public Installation(long id, User account, string accessTokenUrl, string reposit public IReadOnlyList Events { get; private set; } /// - /// The single file the GitHub App can managem (when Permissions.SingleFile is set to read or write) + /// The single file the GitHub App can manage (when Permissions.SingleFile is set to read or write) /// public string SingleFileName { get; protected set; } diff --git a/Octokit/Models/Response/PagesBuild.cs b/Octokit/Models/Response/PagesBuild.cs index 64c5c4aebd..46c8fd0054 100644 --- a/Octokit/Models/Response/PagesBuild.cs +++ b/Octokit/Models/Response/PagesBuild.cs @@ -37,7 +37,7 @@ public PagesBuild(string url, PagesBuildStatus status, ApiError error, User push /// public ApiError Error { get; protected set; } /// - /// The user whose commit intiated the build. + /// The user whose commit initiated the build. /// public User Pusher { get; protected set; } ///