[vim] Add documentation #3217
[vim] Add documentation #3217
Conversation
|
Wonderful! The bottom of the manual seems like a good place. |
| <dl> | ||
| <dt id="vimapi_setOption"><code><strong>setOption(name: string, value: any, ?cm: CodeMirror, ?cfg: object)</strong></code></dt> | ||
| <dd>Sets the value of a VIM option. <code>name</code> should | ||
| be the name of an option. If <code>cfg.scope</code> is not set |
There was a problem hiding this comment.
There's a subtlety that for :set, setOption gets called twice, with and without cm, so even for local-only options you need to expect cm undefined and silently return. I'm not sure if that behavior was intentional. It leads to some ambiguity, and could probably just be fixed at the :set level to detect local-only options, but otherwise it should be documented.
There was a problem hiding this comment.
Added a comment to defineOption to clarify that it's currently not possible to define a buffer-local option that does not have a global value. I mostly didn't add it to the current API because I'm planning to change the signature a bit in the next major release. The current one has far too many arguments.
|
LGTM |
|
Thanks! Left one comment (take it or leave it), but LGTM. |
|
Merged as d5fbfc9 |
Adds documentation for vim mode's programmatic API. It's way past due.
@marijnh I wasn't sure where to put it. I liked that the manual is a one pager so I stuck the vim part at the bottom. Happy to move it somewhere else.
@heppe @dbarnett @kevinushey since you all had a part in writing the API, could you take a look and check for inaccuracies/typos if you have the time? I suggest pulling the patch down and looking at the rendered HTML.