Rename id parameter to commentID in IssuesService comment methods. #886
Conversation
This file contains 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
Also document which IssueComment fields need to be set in EditComment method. This should help improve clarity of the API, and reduce the chance to mix up the wrong IDs. Resolves #885.
googlebot
added
the
cla: yes
dmitshur
commented
Mar 29, 2018
| @@ -118,10 +118,11 @@ func (s *IssuesService) CreateComment(ctx context.Context, owner string, repo st | |||
| } | |||
|
|
|||
| // EditComment updates an issue comment. | |||
| // A non-nil comment.Body must be provided. Other comment fields should be left nil. | |||
There was a problem hiding this comment.
An additional step we can consider doing is checking if any of the comment fields other than Body are set (especially ID), and return an error with helpful text if so.
GitHub API documents that the only input field is body, and it is required. See https://developer.github.com/v3/issues/comments/#edit-a-comment:
A breaking API change to replace IssueComment parameter with a new IssueCommentEdit struct containing only the Body field is another option, but that's a breaking API change.
There was a problem hiding this comment.
This is an idea to consider, but I'm not ready to act on it yet. I'll leave it outside of the scope of this PR. If someone thinks it's worth doing, it can be sent and discussed in a followup PR.
dmitshur
added a commit
that referenced
this pull request
Mar 30, 2018
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.
dmitshur
added a commit
that referenced
this pull request
Apr 2, 2018
…888) 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.
nbareil
pushed a commit
to nbareil/go-github
that referenced
this pull request
May 1, 2018
…oogle#886) Also document which IssueComment fields need to be set in EditComment method. This should help improve clarity of the API, and reduce the chance to mix up the issue vs comment IDs. Resolves google#885.
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.
Also document which
IssueCommentfields need to be set inEditCommentmethod.This should help improve clarity of the API, and reduce the chance to mix up the issue vs comment IDs.
Resolves #885.