diff options
| author | Björn Linse <bjorn.linse@gmail.com> | 2019-03-12 13:55:22 +0100 |
|---|---|---|
| committer | Björn Linse <bjorn.linse@gmail.com> | 2019-03-12 17:17:58 +0100 |
| commit | dec3e027d902a59369550b9da8f6c10da61f06ef (patch) | |
| tree | 93cb7091317e5205b4a7bcdb650ad6e65e4697de /runtime/doc/api.txt | |
| parent | f9d3e69cc91f46abff321e53fad78c5e7342aad4 (diff) | |
| download | rneovim-dec3e027d902a59369550b9da8f6c10da61f06ef.tar.gz rneovim-dec3e027d902a59369550b9da8f6c10da61f06ef.tar.bz2 rneovim-dec3e027d902a59369550b9da8f6c10da61f06ef.zip | |
docs: adjust the generated nvim_open_win docs
The format here is not meant to be ideal, just a backstop until
auto-generation has been fixed.
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 60 |
1 files changed, 36 insertions, 24 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index fe0b8402d3..7172091ceb 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -647,30 +647,42 @@ nvim_open_win({buffer}, {enter}, {width}, {height}, {options}) {height} height of window (in character cells) {options} dict of options for configuring window positioning accepts the following keys: - `relative`: If set, the window becomes a - floating window. The window will be placed with - row,col coordinates relative one of the - following: "editor" the global editor grid - "win" a window. Use 'win' option below to - specify window id, or current window will be - used by default. "cursor" the cursor position - in current window. `anchor`: the corner of the - float that the row,col position defines "NW" - north-west (default) "NE" north-east "SW" - south-west "SE" south-east `focusable`: Whether - window can be focused by wincmds and mouse - events. Defaults to true. Even if set to false, - the window can still be entered using - |nvim_set_current_win()| API call. `row`: row - position. Screen cell height are used as unit. - Can be floating point. `col`: column position. - Screen cell width is used as unit. Can be - floating point. `win`: when using - relative='win', window id of the window where - the position is defined. `external` GUI should - display the window as an external top-level - window. Currently accepts no other positioning - options together with this. + + `relative`: If set, the window becomes a + floating window. The window will be placed with + row,col coordinates relative one of the + following: + "editor" the global editor grid + "win" a window. Use 'win' option below to + specify window id, or current window will + be used by default. + "cursor" the cursor position in current window. + + `anchor`: the corner of the float that the row,col + position defines + "NW" north-west (default) + "NE" north-east + "SW" south-west + "SE" south-east + + `focusable`: Whether window can be focused by wincmds and + mouse events. Defaults to true. Even if set to false, + the window can still be entered using + |nvim_set_current_win()| API call. + + `row`: row position. Screen cell height are used as unit. + Can be floating point. + + `col`: column position. Screen cell width is used as + unit. Can be floating point. + + `win`: when using relative='win', window id of the window + where the position is defined. + + `external`: GUI should display the window as an external + top-level window. Currently accepts no other + positioning options together with this. + With editor positioning row=0, col=0 refers to the top-left corner of the screen-grid and row=Lines-1, Columns-1 refers to the bottom-right corner. Floating point values are allowed, |