nvim: use OpenWindowConfig and fix documentation on OpenWindow

Author: zchee

nvim/apidef.go

@@ -505,30 +505,32 @@ func CreateBuffer(listed, scratch bool) Buffer {
 	name(nvim_create_buf)
 }
 
-// OpenWindow open a new window.
+// OpenWindow opens a new window.
 //
 // Currently this is used to open floating and external windows.
 // Floats are windows that are drawn above the split layout, at some anchor
-// position in some other window. Floats can be draw internally or by external
+// position in some other window. Floats can be drawn internally or by external
 // GUI with the |ui-multigrid| extension. External windows are only supported
 // with multigrid GUIs, and are displayed as separate top-level windows.
 //
-// Exactly one of `external` and `relative` must be specified.
+// For a general overview of floats, see |api-floatwin|.
 //
-// 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, but the builtin implementation (used by
-// TUI and GUIs without multigrid support) will always round down to nearest
-// integer.
+// Exactly one of External and Relative must be specified. The Width and
+// Height of the new window must be specified.
+//
+// With relative=editor (row=0,col=0) refers to the top-left corner of the
+// screen-grid and (row=Lines-1,col=Columns-1) refers to the bottom-right
+// corner. Fractional values are allowed, but the builtin implementation
+// (used by non-multigrid UIs) will always round down to nearest integer.
 //
 // Out-of-bounds values, and configurations that make the float not fit inside
-// the main editor, are allowed. The builtin implementation will truncate
-// values so floats are completely within the main screen grid. External GUIs
+// the main editor, are allowed. The builtin implementation truncates values
+// so floats are fully within the main screen grid. External GUIs
 // could let floats hover outside of the main window like a tooltip, but
 // this should not be used to specify arbitrary WM screen positions.
 //
 // The returns the window handle or 0 when error.
-func OpenWindow(buffer Buffer, enter bool, config map[string]interface{}) Window {
+func OpenWindow(buffer Buffer, enter bool, config *OpenWindowConfig) Window {
 	name(nvim_open_win)
 }
 
@@ -613,7 +615,7 @@ func KeyMap(mode string) []*Mapping {
 //  rhs
 // Right-hand-side {rhs} of the mapping.
 //
-//   opts
+//  opts
 // Optional parameters map. Accepts all :map-arguments as keys excluding <buffer> but including noremap.
 // Values are Booleans. Unknown key is an error.
 func SetKeyMap(mode, lhs, rhs string, opts map[string]bool) {