Qlot's documentation on usage with Vim/Neovim is wrong/could be better

[scarpart]

I use vim with vlime, and I ran into issues setting up the package manager on my machine.

The Issue

This is what is currently found in the README:

let g:vlime_cl_use_terminal = v:true
let s:vlime_path = '/path/to/vlime'
function! VlimeBuildServerCommandFor_qlot(vlime_loader, vlime_eval)
    return ["qlot", "exec", "ros", "run",
               \ "--load", s:vlime_path . "/lisp/load-vlime.lisp",
               \ "--eval", vlime_eval]
endfunction
function! VlimeQlotExec()
    call vlime#server#New(v:true, get(g:, "vlime_cl_use_terminal", v:false), v:null, "qlot")
endfunction

There are a couple of problems here.

1. The vlime_eval parameter to the --eval flag is not prefixed by a:, so it will throw an error regarding the variable as unbound. To fix this, it would have to be replaced by a:vlime_eval.
2. This part of the documentation assumes that one is running using roswell, yet that is not always the case. I could only get it working on my machine after changing the command to "qlot", "exec", "sbcl", "--load" (...). It would be nice to have this as an addendum in the README.

With these two changes I could otherwise get it working fine.

Solution

To this issue, I will attach a PR with these changes. Let me know what you think, or if this is truthfully an issue, or if I was mislead by a misunderstanding/misconfiguration.