1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-04-21 13:51:59 +02:00

docs: Add details to how the Path.relative method works

This commit is contained in:
Sunny Hirai 2021-06-06 12:36:23 -07:00
parent cbe8e1a481
commit 68dba70090

View File

@ -53,7 +53,7 @@ Given a path, get the path to the previous sibling node. The method will throw a
#### `Path.relative(path: Path, ancestor: Path): Path`
Get a path relative to an ancestor.
Given two paths, one that is an ancestor to the other, returns the relative path from the `ancestor` argument to the `path` argument. If the `ancestor` path is not actually an ancestor or equal to the `path` argument, throws an error.
### Check methods