Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos in comments #2040

Merged
merged 1 commit into from
Oct 30, 2019
Merged

Fix typos in comments #2040

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Octokit.Reactive/Clients/IObservableCheckSuitesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public interface IObservableCheckSuitesClient
IObservable<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 @@ -112,7 +112,7 @@ public interface IObservableCheckSuitesClient
IObservable<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
6 changes: 3 additions & 3 deletions Octokit.Reactive/Clients/IObservableMigrationsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ public interface IObservableMigrationsClient
/// https://developer.github.com/v3/migration/migrations/#start-a-migration
/// </remarks>
/// <param name="org">The organization for which to start a migration.</param>
/// <param name="migration">Sprcifies parameters for the migration in a
/// <param name="migration">Specifies parameters for the migration in a
/// <see cref="StartMigrationRequest"/> object.</param>
/// <returns>The started migration.</returns>
IObservable<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 @@ -40,7 +40,7 @@ IObservable<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.Reactive/Clients/IObservableMiscellaneousClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public interface IObservableMiscellaneousClient
IObservable<LicenseMetadata> GetAllLicenses();

/// <summary>
/// Retrieves a license based on the license key such as "mit"
/// Retrieves a license based on the license key such as "MIT"
/// </summary>
/// <param name="key"></param>
/// <returns>A <see cref="License" /> that includes the license key, text, and attributes of the license.</returns>
Expand Down
2 changes: 1 addition & 1 deletion Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ public interface IObservableOrganizationMembersClient
/// Make the authenticated user's organization membership private.
/// </summary>
/// <remarks>
/// This method requries authentication.
/// This method requires authentication.
/// See the <a href="http://developer.github.com/v3/orgs/members/#conceal-a-users-membership">API documentation</a>
/// for more information.
/// </remarks>
Expand Down
8 changes: 4 additions & 4 deletions Octokit.Reactive/Clients/IObservableProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public interface IObservableProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
IObservable<Project> GetAllForOrganization(string organization);

/// <summary>
Expand All @@ -110,7 +110,7 @@ public interface IObservableProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
IObservable<Project> GetAllForOrganization(string organization, ProjectRequest request);

Expand All @@ -120,7 +120,7 @@ public interface IObservableProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Project> GetAllForOrganization(string organization, ApiOptions options);

Expand All @@ -130,7 +130,7 @@ public interface IObservableProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Project> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options);
Expand Down
4 changes: 2 additions & 2 deletions Octokit.Reactive/Clients/IObservableTagsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public interface IObservableTagsClient
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">Tha sha reference of the tag</param>
/// <param name="reference">The sha reference of the tag</param>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<GitTag> Get(string owner, string name, string reference);
Expand All @@ -31,7 +31,7 @@ public interface IObservableTagsClient
/// http://developer.github.com/v3/git/tags/#get-a-tag
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">Tha sha reference of the tag</param>
/// <param name="reference">The sha reference of the tag</param>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<GitTag> Get(long repositoryId, string reference);
Expand Down
2 changes: 1 addition & 1 deletion Octokit.Reactive/Clients/ObservableMiscellaneousClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public IObservable<LicenseMetadata> GetAllLicenses()
}

/// <summary>
/// Retrieves a license based on the license key such as "mit"
/// Retrieves a license based on the license key such as "MIT"
/// </summary>
/// <param name="key"></param>
/// <returns>A <see cref="License" /> that includes the license key, text, and attributes of the license.</returns>
Expand Down
2 changes: 1 addition & 1 deletion Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ public IObservable<bool> Publicize(string org, string user)
/// Make the authenticated user's organization membership private.
/// </summary>
/// <remarks>
/// This method requries authentication.
/// This method requires authentication.
/// See the <a href="http://developer.github.com/v3/orgs/members/#conceal-a-users-membership">API documentation</a>
/// for more information.
/// </remarks>
Expand Down
6 changes: 3 additions & 3 deletions Octokit.Reactive/Clients/ObservableProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ public IObservable<Project> GetAllForOrganization(string organization)
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<Project> GetAllForOrganization(string organization, ApiOptions options)
{
Expand All @@ -193,7 +193,7 @@ public IObservable<Project> GetAllForOrganization(string organization, ApiOption
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
public IObservable<Project> GetAllForOrganization(string organization, ProjectRequest request)
{
Expand All @@ -206,7 +206,7 @@ public IObservable<Project> GetAllForOrganization(string organization, ProjectRe
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
public IObservable<Project> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options)
Expand Down
2 changes: 1 addition & 1 deletion Octokit.Reactive/Clients/ObservableSearchClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Octokit.Reactive
{
/// <summary>
/// GitHub Search Api Client
/// GitHub Search API Client
/// </summary>
public class ObservableSearchClient : IObservableSearchClient
{
Expand Down
4 changes: 2 additions & 2 deletions Octokit/Clients/CheckSuitesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ public async Task<CheckSuitesResponse> GetAllForReference(long repositoryId, str
}

/// <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 @@ -189,7 +189,7 @@ public Task<CheckSuitePreferencesResponse> UpdatePreferences(string owner, strin
}

/// <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
6 changes: 3 additions & 3 deletions Octokit/Clients/IMigrationsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ public interface IMigrationsClient
/// https://developer.github.com/v3/migration/migrations/#start-a-migration
/// </remarks>
/// <param name="org">The organization for which to start a migration.</param>
/// <param name="migration">Sprcifies parameters for the migration in a
/// <param name="migration">Specifies parameters for the migration in a
/// <see cref="StartMigrationRequest"/> object.</param>
/// <returns>The started migration.</returns>
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 @@ -39,7 +39,7 @@ 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/IMiscellaneousClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public interface IMiscellaneousClient
Task<IReadOnlyList<LicenseMetadata>> GetAllLicenses();

/// <summary>
/// Retrieves a license based on the license key such as "mit"
/// Retrieves a license based on the license key such as "MIT"
/// </summary>
/// <param name="key"></param>
/// <returns>A <see cref="License" /> that includes the license key, text, and attributes of the license.</returns>
Expand Down
8 changes: 4 additions & 4 deletions Octokit/Clients/IProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public interface IProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
Task<IReadOnlyList<Project>> GetAllForOrganization(string organization);

/// <summary>
Expand All @@ -111,7 +111,7 @@ public interface IProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, ProjectRequest request);

Expand All @@ -121,7 +121,7 @@ public interface IProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, ApiOptions options);

Expand All @@ -131,7 +131,7 @@ public interface IProjectsClient
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options);
Expand Down
8 changes: 4 additions & 4 deletions Octokit/Clients/ProjectsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public Task<IReadOnlyList<Project>> GetAllForRepository(long repositoryId, Proje
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization)
{
return GetAllForOrganization(organization, ApiOptions.None);
Expand All @@ -160,7 +160,7 @@ public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization)
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="options">Options for changing the API response</param>
public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, ApiOptions options)
{
Expand All @@ -177,7 +177,7 @@ public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, A
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, ProjectRequest request)
{
Expand All @@ -193,7 +193,7 @@ public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, P
/// <remarks>
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
/// </remarks>
/// <param name="organization">The name of the organziation</param>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter the list of projects returned</param>
/// <param name="options">Options for changing the API response</param>
public Task<IReadOnlyList<Project>> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options)
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Exceptions/AbuseException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Octokit
{
/// <summary>
/// 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.
/// </summary>
#if !NO_SERIALIZABLE
[Serializable]
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Exceptions/ApiException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public override string Message
}

/// <summary>
/// The HTTP status code associated with the repsonse
/// The HTTP status code associated with the response
/// </summary>
public HttpStatusCode StatusCode { get; private set; }

Expand Down
2 changes: 1 addition & 1 deletion Octokit/Exceptions/PullRequestMismatchException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace Octokit
public class PullRequestMismatchException : ApiException
{
/// <summary>
/// Constructs an instace of <see cref="Octokit.PullRequestMismatchException"/>.
/// Constructs an instance of <see cref="Octokit.PullRequestMismatchException"/>.
/// </summary>
/// <param name="response"></param>
public PullRequestMismatchException(IResponse response) : this(response, null)
Expand Down
Loading