Change number int to commentID int64 in PRsService comment methods. #888
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a breaking API change that is a part of issue #597. It should've been applied earlier, but we missed it because the parameter was misleadingly named number rather than id or commentID. Rename the parameter to commentID to make it more clear that it's the comment ID and not the PR ID nor PR number. This should help improve clarity of the API, and reduce the chance to mix up the IDs. Also document which PullRequestComment fields need to be set in EditComment method. Similar to #886. Updates #885. Updates #597.
googlebot
added
the
cla: yes
willnorris
approved these changes
Mar 30, 2018
|
Thanks for reviewing. Since it's a breaking change, I'll wait for Monday before merging (so people can have a nice weekend). |
nbareil
pushed a commit
to nbareil/go-github
that referenced
this pull request
May 1, 2018
…oogle#888) This is a breaking API change that is a part of issue google#597. It should've been applied earlier, but we missed it because the parameter was misleadingly named number rather than id or commentID. Rename the parameter to commentID to make it more clear that it's the comment ID and not the PR ID nor PR number. This should help improve clarity of the API, and reduce the chance to mix up the IDs. Also document which PullRequestComment fields need to be set in EditComment method. Similar to google#886. Updates google#885. Updates google#597.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a breaking API change that is a part of issue #597. It should've been applied earlier, but we missed it because the parameter was misleadingly named
numberrather thanidorcommentID.Rename the parameter to
commentIDto make it more clear that it's the comment ID and not the PR ID nor PR number. This should help improve clarity of the API, and reduce the chance to mix up the IDs.Also document which
PullRequestCommentfields need to be set inEditCommentmethod.Similar to #886.
Updates #885.
Updates #597.