From 6bc57583587d88b26fb03e054511b6d7ac23ef7c Mon Sep 17 00:00:00 2001 From: Pengfei Han Date: Wed, 27 Nov 2024 02:49:43 +0800 Subject: [PATCH] docs: specify default value of `edge` in `Editor.point` as `start` (#5765) 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. --- docs/api/nodes/editor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/nodes/editor.md b/docs/api/nodes/editor.md index 6b628bdcc3..f48bcaa10d 100644 --- a/docs/api/nodes/editor.md +++ b/docs/api/nodes/editor.md @@ -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'}`