From ce92a0aa82af24077f5b07fbdb8fa45f55918cb6 Mon Sep 17 00:00:00 2001
From: Ole Rehmsen <oler@google.com>
Date: Thu, 4 Feb 2021 17:48:09 +0100
Subject: [PATCH] Add some more docs about the range type

Change-Id: I0586d9b71a4581ef56b902668c1020374020a195
---
 polygerrit-ui/app/api/core.ts | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/polygerrit-ui/app/api/core.ts b/polygerrit-ui/app/api/core.ts
index 245f0af79c..91c2b7b8ad 100644
--- a/polygerrit-ui/app/api/core.ts
+++ b/polygerrit-ui/app/api/core.ts
@@ -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;
 }