diff options
| -rw-r--r-- | lib/line-index/src/lib.rs | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/line-index/src/lib.rs b/lib/line-index/src/lib.rs index b29717e0a7b..2c71e8e7632 100644 --- a/lib/line-index/src/lib.rs +++ b/lib/line-index/src/lib.rs @@ -143,14 +143,15 @@ impl LineIndex { /// /// # Panics /// - /// If the offset is invalid. + /// If the offset is invalid. See [`Self::try_line_col`]. pub fn line_col(&self, offset: TextSize) -> LineCol { self.try_line_col(offset).expect("invalid offset") } - /// Transforms the `TextSize` into a `LineCol`, or returns `None` if the `offset` was invalid, - /// e.g. if it extends past the end of the text or points to the middle of a multi-byte - /// character. + /// Transforms the `TextSize` into a `LineCol`. + /// + /// Returns `None` if the `offset` was invalid, e.g. if it extends past the end of the text or + /// points to the middle of a multi-byte character. pub fn try_line_col(&self, offset: TextSize) -> Option<LineCol> { if offset > self.size { return None; |