Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GuiNewWindow Improve Documentation #899

Open
jgehrig opened this issue Jul 27, 2021 · 1 comment
Open

GuiNewWindow Improve Documentation #899

jgehrig opened this issue Jul 27, 2021 · 1 comment

Comments

@jgehrig
Copy link
Collaborator

jgehrig commented Jul 27, 2021

Usage of the command is unclear (at least to me):

							*GuiNewWindow(opts)*
|GuiNewWindow()| creates a new window with the given map of arguments.
Supported arguments are:

The following parameters describe the fields in {opts}.

Parameters: ~
	{server} (optional, string): Server to connect to for the new window.
	{nvim} (optional, string): Path to nvim instance.

I think the command is used like this?
:GuiNewWindow({"server": "arg", "nvim": "arg"}).

We should be explicit about the usage. If it is not dead-simple/obvious, we will get bug reports.

We also need to allow :GuiNewWindow() without any arguments. I suspect this is how most users will invoke the command?

@jgehrig
Copy link
Collaborator Author

jgehrig commented Jul 27, 2021

We should also add something to the Wiki:
https://github.com/equalsraf/neovim-qt/wiki/Configuration-Options

@jgehrig jgehrig assigned jgehrig and unassigned jgehrig Jul 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant