opendev/gerrit
Code Issues Proposed changes

Merge "Add some more docs about the range type"

Browse Source
This commit is contained in:
Ole Rehmsen
2021-02-05 09:16:35 +00:00
committed by Gerrit Code Review
parent c35714dc23 ce92a0aa82
commit 32f18ee574
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
polygerrit-ui/app/api/core.ts
View File

@@ -22,10 +22,26 @@
/**
* The CommentRange entity describes the range of an inline comment.
* https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#comment-range
*
* The range includes all characters from the start position, specified by
* start_line and start_character, to the end position, specified by end_line
* and end_character. The start position is inclusive and the end position is
* exclusive.
*
* So, a range over part of a line will have start_line equal to end_line;
* however a range with end_line set to 5 and end_character equal to 0 will not
* include any characters on line 5.
*/
export interface CommentRange {
/** The start line number of the range. (1-based) */
start_line: number;
/** The character position in the start line. (0-based) */
start_character: number;
/** The end line number of the range. (1-based) */
end_line: number;
/** The character position in the end line. (0-based) */
end_character: number;
}