Commit Graph

25 Commits

Author SHA1 Message Date
Justin M. Keyes
dc6cc4787c api: Establish API naming convention. (#5344)
old name:                   new name:
  --------------------------------------------------
  nvim_name_to_color          nvim_get_color_by_name
  nvim_get_current_buffer     nvim_get_current_buf
  nvim_get_current_window     nvim_get_current_win
  nvim_get_buffers            nvim_list_bufs
  nvim_get_tabpages           nvim_list_tabpages
  nvim_get_windows            nvim_list_wins
  nvim_set_current_buffer     nvim_set_current_buf
  nvim_set_current_window     nvim_set_current_win
  nvim_change_directory       nvim_set_current_dir
  nvim_tabpage_get_window     nvim_tabpage_get_win
  nvim_tabpage_get_windows    nvim_tabpage_list_wins
  nvim_win_get_buffer         nvim_win_get_buf
  nvim_report_error           nvim_err_writeln

Helped-by: Björn Linse <bjorn.linse@gmail.com>
Helped-by: ZyX <kp-pav@yandex.ru>
Helped-by: James McCoy <jamessan@jamessan.com>
2016-09-17 06:30:36 +02:00
Björn Linse
1c22cab2fd api: consistently use nvim_ prefix and update documentation 2016-08-31 21:57:06 +02:00
Björn Linse
8d6e3f2b88 api/ui: add documentation for remote ui redraw events 2016-08-29 10:17:31 +02:00
Björn Linse
2d60a15e25 job control: reuse common job code for rpc jobs
This makes stderr and exit callbacks work for rpc jobs
2016-08-20 12:55:35 +02:00
Justin M. Keyes
8c28baa7c7 doc: api_info 2016-06-18 15:01:51 -04:00
Björn Linse
16424caeda eval: add api_info()
Previously, the api metadata was only accessible frow within nvim as
msgpackparse(systemlist('nvim --api-info'))[0]
2016-06-17 18:47:45 +02:00
Justin M. Keyes
2dbf040048 doc: uppercase RPC 2016-06-15 22:50:37 -04:00
Justin M. Keyes
cc6edfe357 doc: remove "nvim-" qualfier from tags
It is almost never necessary to qualify documentation as "Nvim
specific".

The main exception to this is vim_diff.txt.
2016-06-15 19:29:27 -04:00
Justin M. Keyes
23a3e58f02 doc: msgpack_rpc: De-emphasize the transport protocol.
Tighten our jargon, avoid mentioning "msgpack" everywhere we mention the
RPC API. Prefer "RPC API" when speaking about the remote API.

Though it's conceivable that we may one day support some protocol other
than msgpack, that isn't relevant to most of our discussion of the API,
including this document.

The file name msgpack_rpc.txt is preserved to avoid totally breaking
URLs.
2016-06-15 19:29:26 -04:00
Björn Linse
2a4ea9a546 docs: start api docs and document highlight mechanism 2016-02-23 21:29:02 +01:00
Björn Linse
57d3a2a52f api: represent api type String as msgpack type STR. closes #1250 2015-10-08 20:18:46 +02:00
alecbrooks
e8c82372ff doc: Revise for flow and consistency #2831
In general, attempt to make things more concise.

Reviewed-by: Michael Reed <m.reed@mykolab.com>
2015-06-24 09:15:58 -04:00
Justin M. Keyes
84443f176e doc: v:servername, serverstart() 2015-05-17 02:17:34 -04:00
Scott Prager
c4da6bf2ba docs: update for rpcstart('nvim', ['--embed'])
Also, edit the reference to the non-existent api function,
vim_list_buffers, to vim_get_buffers.
2015-04-13 10:20:42 -04:00
Justin M. Keyes
adfc8cf50a doc: Misc. cleanup
Add missing parentheses and whatnot, move dangling comment, etc. Some
specific items worth mentioning:

Fixed some references to non-existent tags, found via `make html`

msgpack_rpc/channel.c:
  ELOG already prefixes each line with "error @ ..."
2015-03-24 19:29:29 -04:00
Geoff Harcourt
c0a668aa26 docs: Clean up python, provider, remote_plugin #2056
* "Python" is a proper noun and should be capitalized in prose
* Corrected use of "its/it's"
* Used better preposition to describe something "in" legacy Vim
* Combine fragments into complete sentence
2015-03-08 17:23:48 -04:00
Michael Reed
e0f66137d1 docs: Misc. improvements to job_control/msgpack
- Rewrote a few sentences for clarity/brevity
- Various spelling/grammar fixes
- Mention exact time before SIGKILL (mentioned in /src/nvim/os/job.c)
- Reflowed all changed paragraphs accordingly
- Standardize indentation level
- Remove trailing whitespace

- Job control example:
  - Don't buffer output (echo -n); just print a new line for every
    update.
  - Use single quotes around jobsend() arguments to allow for proper
    interpretation of newline characters.
  - Sleep 1 second between updates instead of 2; 10 seconds is plenty of
    time for such a simple example.
2015-01-11 16:50:24 -05:00
Eliseo Martínez
2ff36db571 Fix outdated msgpack-rpc doc.
Needed after neovim/python-client#58.
2014-11-26 12:13:49 +01:00
Eliseo Martínez
f7b5fd6f3f Fix warnings: Fix outdated doc: Connecting to nvim through python REPL.
After neovim/python-client@b8b48bbe8f,
docs were no longer relevant.
2014-11-21 12:35:51 +01:00
James Baumgarten
06e5c2c063 doc: update msgpack_rpc documentation to use nvim as variable name #1470 2014-11-17 17:41:14 -05:00
Alex Genco
92aba9e942 Fix api metadata function name in docs
The documentation mentions `vim_get_api_metadata`, but the actual function is `vim_get_api_info`
2014-11-13 21:47:08 -08:00
Michael Reed
61ef9b21c7 runtime/docs/msgpack-rpc: Misc. fixes
- Correct apostrophe usage, primarily with it's/its
- Correct usage of 'e.g.'
- Capitalize acronyms
- Prepend NVIM_LISTEN_ADDRESS with '$' to match previous instance
- Avoid awkward phrasing
- Make lists with an explicitly stated number of points numbered to
  match other such lists
- Added space before parentheses
- rm trailing whitespace
2014-11-03 16:30:31 -05:00
Stefan Hoffmann
73f7837350 doc: cleanup
* fix some links
  * typo
  * remove reference to hangul_input
  * remove unused vim2html.pl
2014-10-06 22:43:30 +02:00
Thiago de Arruda
e59d1c5816 runtime: Some nvim documentation fixes pointed by @oni-link 2014-09-15 08:21:31 -03:00
Thiago de Arruda
eecdbb57fa runtime: Initial msgpack-rpc documentation 2014-09-13 21:35:47 -03:00