Add remove_assignees method to the client #984
Conversation
|
@tarebyte, anything I can do to help get this merged? |
There was a problem hiding this comment.
Thanks for tackling this @licatajustin ✨
I have one bit of feedback and then this should be good to 🚢
lib/octokit/client/issues.rb
Outdated
| # @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue | ||
| # @example Remove assignees "pengwynn" and "joeyw" from Issue #23 on octokit/octokit.rb | ||
| # Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"]) | ||
| def remove_assignees(repo, number, assignees) |
There was a problem hiding this comment.
This is missing the normal patter of an options hash as the last argument, would you mind adding it?
def remove_assignees(repo, number, assignees, options = {})
# ...
endThere was a problem hiding this comment.
Sounds good. Just updated the commit.
|
Let me know if anything else is needed @tarebyte! |
| # @param repo [Integer, String, Repository, Hash] A GitHub repository | ||
| # @param number [Integer] Issue number | ||
| # @param assignees [Array] Assignees to be removed | ||
| # @return [Sawyer::Resource] Issue |
There was a problem hiding this comment.
We're missing the options hash in the documentation here.
There was a problem hiding this comment.
Thanks @kytrinyx for the review.
What are you expecting here? The options argument doesn't seem very useful outside of consistency efforts with the rest of this library, as the GitHub API doesn't allow for additional parameters.
There was a problem hiding this comment.
Unless I'm missing something, the options hash is where you would pass things like custom accept headers.
There was a problem hiding this comment.
Dang. I was a bit quick to merge. Still not seeing the options hash—I'll add it in a separate PR.
GitHub exposes an API to remove assignees from an Issue/Pull Request.
This Pull Request exposes an API for the octokit library to take
advantage of this endpoint.
Usage:
Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"])
|
This has been released as part of https://github.com/octokit/octokit.rb/releases/tag/v4.9.0 |
Issue
Closes #983
Context
GitHub exposes an API to remove assignees from an Issue/Pull Request. This Pull Request takes advantage of that by adding a public method exposed in
Octokit::Client.Please refer to GitHub's API for reference.
Usage: