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

Rename Relationship methods section to Retrieval methods

Browse Source
This commit is contained in:
Sunny Hirai
2021-03-29 23:34:11 -07:00
parent c85a2e0dea
commit f0bcc8be83
4 changed files with 8 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/node.md
View File

@@ -2,13 +2,11 @@
## Static methods ## Static methods
- [Getter methods](#getter-methods) - [Retrieval methods](#retrieval-methods)
- [Text methods](#text-methods) - [Text methods](#text-methods)
- [Check methods](#check-methods) - [Check methods](#check-methods)
### Getter methods ### Retrieval methods
Methods used to retrieve nodes.
###### `Node.ancestor(root: Node, path: Path): Ancestor` ###### `Node.ancestor(root: Node, path: Path): Ancestor`

6
docs/api/path.md
View File

@@ -8,13 +8,11 @@ type Path = number[]
## Static methods ## Static methods
- [Relationship methods](#relationship-methods) - [Retrieval methods](#retrieval-methods)
- [Check methods](#check-methods) - [Check methods](#check-methods)
- [Transform method](#transform-method) - [Transform method](#transform-method)
### Relationship methods ### Retrieval methods
The relationships around the Path like its ancestors, next sibling, etc.
###### `Path.ancestors(path: Path, options: { reverse?: boolean } = {}): Path[]` ###### `Path.ancestors(path: Path, options: { reverse?: boolean } = {}): Path[]`

4
docs/api/point.md
View File

@@ -12,11 +12,11 @@ interface Point {
## Static methods ## Static methods
- [Relationship methods](#relationship-methods) - [Retrieval methods](#retrieval-methods)
- [Check methods](#check-methods) - [Check methods](#check-methods)
- [Transform method](#transform-method) - [Transform method](#transform-method)
### Relationship methods ### Retrieval methods
###### `Point.compare(point: Point, another: Point): -1 | 0 | 1` ###### `Point.compare(point: Point, another: Point): -1 | 0 | 1`

6
docs/api/range.md
View File

@@ -12,13 +12,11 @@ interface Range {
## Static methods ## Static methods
- [Relationship methods](#relationship-methods) - [Retrieval methods](#retrieval-methods)
- [Check methods](#check-methods) - [Check methods](#check-methods)
- [Transform method](#transform-method) - [Transform method](#transform-method)
### Relationship methods ### Retrieval methods
Relationship of a Range like its start and end points and the intersection with another Range.
###### `Range.edges(range: Range, options?): [Point, Point]` ###### `Range.edges(range: Range, options?): [Point, Point]`