diff options
author | 2016-06-16 23:29:56 -0400 | |
---|---|---|
committer | 2016-06-16 23:29:56 -0400 | |
commit | 4e55b247304ebc962d59ffa61d8788df802b0d6a (patch) | |
tree | e502b3e57a216efaa7dbef95c0a5bdf9ea76231a /core/.view.luadoc | |
parent | b2a88f20460e036012156aa2085114befadfd9af (diff) |
Changed arguments to `ui.goto_view()` and `view:goto_buffer()`.
They can accept either objects or relative numbers now. They do not accept
absolute indices anymore.
Diffstat (limited to 'core/.view.luadoc')
-rw-r--r-- | core/.view.luadoc | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc index 2ae3cb43..4f4af0d2 100644 --- a/core/.view.luadoc +++ b/core/.view.luadoc @@ -33,16 +33,12 @@ function split(view, vertical) end function unsplit(view) end --- --- Switches to buffer number *n* in the view. --- *relative* indicates whether or not *n* is an index relative to the current --- buffer's index in `_BUFFERS` instead of an absolute index. +-- Switches to buffer *buffer* or the buffer *buffer* number of buffers relative +-- to the current one. -- Emits `BUFFER_BEFORE_SWITCH` and `BUFFER_AFTER_SWITCH` events. -- @param view The view to switch buffers in. --- @param n A relative or absolute buffer index in `_BUFFERS`. An absolute index --- of `-1` goes to the last buffer. --- @param relative Optional flag indicating whether *n* is a relative or --- absolute index. The default value is `false`, for an absolute index. +-- @param buffer A buffer or relative buffer number (typically 1 or -1). -- @see _G._BUFFERS -- @see events.BUFFER_BEFORE_SWITCH -- @see events.BUFFER_AFTER_SWITCH -function goto_buffer(view, n, relative) end +function goto_buffer(view, buffer) end |