diff --git a/Octokit/Clients/IPullRequestsClient.cs b/Octokit/Clients/IPullRequestsClient.cs index 0f8a4e3a..d64dfd2b 100644 --- a/Octokit/Clients/IPullRequestsClient.cs +++ b/Octokit/Clients/IPullRequestsClient.cs @@ -7,7 +7,7 @@ namespace Octokit public interface IPullRequestsClient { /// - /// Gets a single Pull Request by number. + /// Get a pull request by number. /// /// /// http://developer.github.com/v3/pulls/#get-a-single-pull-request @@ -18,18 +18,18 @@ namespace Octokit Task Get(string owner, string name, int number); /// - /// Gets all open pull requests for the repository. + /// Get all open pull requests for the repository. /// /// /// http://developer.github.com/v3/pulls/#list-pull-requests /// /// The owner of the repository /// The name of the repository - /// + /// A of s which are currently open Task> GetForRepository(string owner, string name); /// - /// Gets all open pull requests for the repository. + /// Get pull requests for the repository based on a given criteria /// /// /// http://developer.github.com/v3/pulls/#list-pull-requests @@ -37,21 +37,21 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Used to filter and sort the list of pull requests returned - /// + /// A of s which match the criteria Task> GetForRepository(string owner, string name, PullRequestRequest request); /// - /// Creates a pull request for the specified repository. + /// Create a pull request for the specified repository. /// /// http://developer.github.com/v3/pulls/#create-a-pull-request /// The owner of the repository /// The name of the repository /// A instance describing the new PullRequest to create - /// + /// A result which was created on the server Task Create(string owner, string name, NewPullRequest newPullRequest); /// - /// Creates a pull request for the specified repository. + /// Create a pull request for the specified repository. /// /// http://developer.github.com/v3/pulls/#update-a-pull-request /// The owner of the repository @@ -59,38 +59,38 @@ namespace Octokit /// The PullRequest number /// An instance describing the changes to make to the PullRequest /// - /// + /// An updated result Task Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate); /// - /// Merges a pull request. + /// Merge a pull request. /// /// http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade /// The owner of the repository /// The name of the repository /// The pull request number /// A instance describing a pull request merge - /// + /// An result which indicates the merge result Task Merge(string owner, string name, int number, MergePullRequest mergePullRequest); /// - /// Gets the pull request merge status. + /// Get the pull request merge status. /// /// http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged /// The owner of the repository /// The name of the repository /// The pull request number - /// + /// True if the operation has been merged, false otherwise Task Merged(string owner, string name, int number); /// - /// Gets the list of commits on a pull request. + /// Get the list of commits on a pull request. /// /// http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request /// The owner of the repository /// The name of the repository /// The pull request number - /// + /// A of s which are part of this pull request Task> Commits(string owner, string name, int number); } } diff --git a/Octokit/Clients/PullRequestsClient.cs b/Octokit/Clients/PullRequestsClient.cs index abc7ce7a..642ec503 100644 --- a/Octokit/Clients/PullRequestsClient.cs +++ b/Octokit/Clients/PullRequestsClient.cs @@ -13,7 +13,7 @@ namespace Octokit } /// - /// Gets a single Pull Request by number. + /// Get a pull request by number. /// /// /// http://developer.github.com/v3/pulls/#get-a-single-pull-request @@ -28,21 +28,21 @@ namespace Octokit } /// - /// Gets all open pull requests for the repository. + /// Get all open pull requests for the repository. /// /// /// http://developer.github.com/v3/pulls/#list-pull-requests /// /// The owner of the repository /// The name of the repository - /// + /// A of s which are currently open public Task> GetForRepository(string owner, string name) { return GetForRepository(owner, name, new PullRequestRequest()); } /// - /// Gets all open pull requests for the repository. + /// Get pull requests for the repository based on a given criteria /// /// /// http://developer.github.com/v3/pulls/#list-pull-requests @@ -50,7 +50,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Used to filter and sort the list of pull requests returned - /// + /// A of s which match the criteria public Task> GetForRepository(string owner, string name, PullRequestRequest request) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -62,13 +62,13 @@ namespace Octokit } /// - /// Creates a pull request for the specified repository. + /// Create a pull request for the specified repository. /// /// http://developer.github.com/v3/pulls/#create-a-pull-request /// The owner of the repository /// The name of the repository /// A instance describing the new PullRequest to create - /// + /// A result which was created on the server public Task Create(string owner, string name, NewPullRequest newPullRequest) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -79,7 +79,7 @@ namespace Octokit } /// - /// Creates a pull request for the specified repository. + /// Create a pull request for the specified repository. /// /// http://developer.github.com/v3/pulls/#update-a-pull-request /// The owner of the repository @@ -87,7 +87,7 @@ namespace Octokit /// The PullRequest number /// An instance describing the changes to make to the PullRequest /// - /// + /// An updated result public Task Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -98,14 +98,14 @@ namespace Octokit } /// - /// Merges a pull request. + /// Merge a pull request. /// /// http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade /// The owner of the repository /// The name of the repository /// The pull request number /// A instance describing a pull request merge - /// + /// An result which indicates the merge result public Task Merge(string owner, string name, int number, MergePullRequest mergePullRequest) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -116,13 +116,13 @@ namespace Octokit } /// - /// Gets the pull request merge status. + /// Get the pull request merge status. /// /// http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged /// The owner of the repository /// The name of the repository /// The pull request number - /// + /// True if the operation has been merged, false otherwise public async Task Merged(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -146,13 +146,13 @@ namespace Octokit } /// - /// Gets the list of commits on a pull request. + /// Get the list of commits on a pull request. /// /// http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request /// The owner of the repository /// The name of the repository /// The pull request number - /// + /// A of s which are part of this pull request public Task> Commits(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner");