Skip to content

Commit

Permalink
docs: specify default value of edge in Editor.point as start
Browse files Browse the repository at this point in the history
Clarify in the documentation that the default value for `edge` in `Editor.point` is `start`.
This is helpful for developers who are not deeply familiar with the framework but need to quickly use it for development.
They no longer need to inspect the source code or experiment with sample code to understand the default behavior.
  • Loading branch information
CFlyGoo authored Nov 16, 2024
1 parent 49ba21a commit 24b05a7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api/nodes/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Options: `{depth?: number, edge?: 'start' | 'end'}`

#### `Editor.point(editor: Editor, at: Location, options?) => Point`

Get the start or end point of a location.
Get the `start` or `end` (default is `start`) point of a location.

Options: `{edge?: 'start' | 'end'}`

Expand Down

0 comments on commit 24b05a7

Please sign in to comment.