From 03e823019642fdb44fa332d6b9054e099dc502b1 Mon Sep 17 00:00:00 2001 From: Sunny Hirai Date: Thu, 8 Jul 2021 13:12:11 -0700 Subject: [PATCH] docs: Improve documentation around Editor.before and Editor.after --- docs/api/nodes/editor.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/nodes/editor.md b/docs/api/nodes/editor.md index e9c63d672..01ea818ed 100644 --- a/docs/api/nodes/editor.md +++ b/docs/api/nodes/editor.md @@ -65,12 +65,16 @@ Options: Get the point after a location. +If there is no point after the location (e.g. we are at the bottom of the document) returns `undefined`. + Options: `{distance?: number, unit?: 'offset' | 'character' | 'word' | 'line' | 'block', voids?: boolean}` #### `Editor.before(editor: Editor, at: Location, options?) => Point | undefined` Get the point before a location. +If there is no point before the location (e.g. we are at the top of the document) returns `undefined`. + Options: `{distance?: number, unit?: 'offset' | 'character' | 'word' | 'line' | 'block', voids?: boolean}` #### `Editor.edges(editor: Editor, at: Location) => [Point, Point]`