aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/bookmarks.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2013-09-06 23:42:13 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2013-09-06 23:42:13 -0400
commit9bff1b29293b50e506936e93c14d7a65e8b0ea29 (patch)
tree0347f3706b6f2fc6233272f75b3f2341e24071a6 /modules/textadept/bookmarks.lua
parentc1f943631f518390869220966cfd10dfa4278165 (diff)
downloadtextadept-9bff1b29293b50e506936e93c14d7a65e8b0ea29.tar.gz
textadept-9bff1b29293b50e506936e93c14d7a65e8b0ea29.zip
Updated LuaDoc.
Diffstat (limited to 'modules/textadept/bookmarks.lua')
-rw-r--r--modules/textadept/bookmarks.lua7
1 files changed, 4 insertions, 3 deletions
diff --git a/modules/textadept/bookmarks.lua b/modules/textadept/bookmarks.lua
index 4e2d7b03..525befa9 100644
--- a/modules/textadept/bookmarks.lua
+++ b/modules/textadept/bookmarks.lua
@@ -37,9 +37,10 @@ function M.clear()
end
---
--- Prompts the user to select a bookmarked line to go to unless *next* is given.
--- If *next* is `true` or `false`, goes to the next or previous bookmark,
--- respectively.
+-- Prompts the user to select a bookmarked line to move the caret to the
+-- beginning of unless *next* is given.
+-- If *next* is `true` or `false`, moves the caret to the beginning of the next
+-- or previously bookmarked line, respectively.
-- @param next Optional flag indicating whether to go to the next or previous
-- bookmarked line relative to the current line. The default value is `nil`,
-- prompting the user for a bookmarked line to go to.