mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-30 02:19:52 +02:00
Code Issues Releases Wiki Activity

docs: Expand on Path.parent that it throws an Error if at the root

Browse Source
This commit is contained in:
Sunny Hirai
2021-06-06 12:40:05 -07:00
parent 68dba70090
commit 402b93ecc1
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/locations/path.md
View File

@@ -33,7 +33,7 @@ Note: Two paths of unequal length can still receive a `0` result if one is direc
#### `Path.levels(path: Path, options?): Path[]` #### `Path.levels(path: Path, options?): Path[]`
Get a list of paths at every level down to a path. Note: this is the same as `Path.ancestors`, but including the path itself. Get a list of paths at every level down to a path. Note: this is the same as `Path.ancestors`, but includes the path itself.
The paths are sorted from shallowest to deepest. However, if the `reverse: true` option is passed, they are reversed. The paths are sorted from shallowest to deepest. However, if the `reverse: true` option is passed, they are reversed.
@@ -45,7 +45,7 @@ Given a path, gets the path to the next sibling node. The method does not ensure
#### `Path.parent(path: Path): Path` #### `Path.parent(path: Path): Path`
Given a path, return a new path referring to the parent node above it. Given a path, return a new path referring to the parent node above it. If the `path` argument is equal to `[]`, throws an error.
#### `Path.previous(path: Path): Path` #### `Path.previous(path: Path): Path`