Rename Comment to ReviewComment #1520
Conversation
|
I changed this in the |
| IObservablePullRequestReviewCommentsClient Comment { get; } | ||
| IObservablePullRequestReviewCommentsClient ReviewComment { get; } |
There was a problem hiding this comment.
Separate the old member and the new member with a line of whitespace, and dont forget to add XmlDoc for the new member
eg:
/// <summary>
/// Client for managing comments.
/// </summary>
[Obsolete("Please use IObservablePullRequestsClient.ReviewComment. This will be removed in a future version")]
IObservablePullRequestReviewCommentsClient Comment { get; }
/// <summary>
/// Client for managing review comments.
/// </summary>
IObservablePullRequestReviewCommentsClient ReviewComment { get; }| @@ -18,15 +18,17 @@ public class ObservablePullRequestsClient : IObservablePullRequestsClient | |||
| /// <summary> | |||
| /// Client for managing comments. | |||
| /// </summary> | |||
| public IObservablePullRequestReviewCommentsClient Comment { get; private set; } | |||
| [Obsolete("Please use ObservablePullRequestsClient.ReviewComment. This will be removed in a future version")] | |||
| public IObservablePullRequestReviewCommentsClient Comment { get; set; } | |||
There was a problem hiding this comment.
We still need the Comment endpoint to function so let's make it a getter only, and have it return the new client
eg
public IObservablePullRequestReviewCommentsClient Comment { get { return this.ReviewComment; } }| public IObservablePullRequestReviewCommentsClient Comment { get; private set; } | ||
| [Obsolete("Please use ObservablePullRequestsClient.ReviewComment. This will be removed in a future version")] | ||
| public IObservablePullRequestReviewCommentsClient Comment { get; set; } | ||
| public IObservablePullRequestReviewCommentsClient ReviewComment { get; private set; } |
There was a problem hiding this comment.
Same comments about whitespace and XmlDoc here
| IPullRequestReviewCommentsClient Comment { get; } | ||
| /// <summary> |
There was a problem hiding this comment.
fix formatting (whitespace) here for consistency
| IPullRequestReviewCommentsClient Comment { get; } | ||
| /// <summary> | ||
| /// Client for managing comments. |
There was a problem hiding this comment.
I guess this comment should say "Client for managing review comments" now?
| public IPullRequestReviewCommentsClient Comment { get; private set; } | ||
|
|
||
| [Obsolete("Please use PullRequestsClient.ReviewComment instead. This method will be removed in a future version")] | ||
| public IPullRequestReviewCommentsClient Comment { get; set; } |
There was a problem hiding this comment.
same comments around getter only, whitespace, and xmldoc wording change
have Comment return new ReviewComment
|
@ryangribble I have made the requested changes. |
|
Great work... Many thanks for your contribution, this is good to go! |
ryangribble
changed the title
ryangribble
changed the title
|
release_notes: Rename PullRequest.Comment to PullRequest.ReviewComment for better accuracy |
nickfloyd
added
Type: Feature
Fixes #1511
Change references of Comment to ReviewComment based on the API change