Skip to content

Commit

Permalink
Doc string change
Browse files Browse the repository at this point in the history
  • Loading branch information
georgii-borovinskikh-sonarsource committed Nov 29, 2023
1 parent 313ebfb commit 0d42b34
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/ConnectedMode/IssueMatcher.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ internal interface IIssueMatcher
bool IsLikelyMatch(IFilterableIssue issue, SonarQubeIssue serverIssue);

/// <summary>
/// Returns the first matching issue. Note: for this method to work correctly, all <paramref name="serverIssuesFromSameFile"/> need to be from the same server file
/// Returns the first matching issue. Note: for this method to work correctly, all <paramref name="serverIssuesFromSameFile"/> need to be from the same server file.
/// False Positives are possible, since <see cref="IsLikelyMatch"/> can return true for multiple issues in the same file and only the firs one is returned.
/// </summary>
/// <param name="issue">Local issue</param>
/// <param name="serverIssuesFromSameFile">List of server issues from the same file</param>
Expand Down

0 comments on commit 0d42b34

Please sign in to comment.