Skip to content

Commit

Permalink
docs: clarify Range.includes method to mean intersects
Browse files Browse the repository at this point in the history
  • Loading branch information
thesunny committed May 21, 2021
1 parent 438722d commit b5f3678
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api/locations/range.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Check if a `range` is exactly equal to `another`.

Check if a `range` includes a path, a point, or part of another range.

For clarity the definition of `includes` can mean partially includes. Another way to describe this is if one Range intersectns the other Range.

#### `Range.isBackward(range: Range): boolean`

Check if a `range` is backward, meaning that its anchor point appears _after_ its focus point in the document.
Expand Down

0 comments on commit b5f3678

Please sign in to comment.