From d96a88252eb380a0c3fdf3321c3a4fa881237420 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ph=E1=BA=A1m=20B=C3=ACnh=20An?= <111893501+brianhuster@users.noreply.github.com> Date: Wed, 28 Jan 2026 05:14:57 +0700 Subject: [PATCH] docs: misc #37357 Problem: - According to [pipx documentation](https://pipx.pypa.io/stable/docs/#pipx-install), `pipx install` doesn't have --upgrade argument. Running `pipx install --upgrade pynvim` results in an error "unrecognized arguments: --upgrade" - In file if_pyth.txt:317, it says "Implementation is ... written in C". This is not true for Nvim, since find_module logic of Nvim's Python interface is implemented in Python. (https://github.com/neovim/pynvim/blob/fdaae821a9df8574c4429d0e87fa43eef08f01aa/pynvim/plugin/script_host.py#L217) - $NVIM_LISTEN_ADDRESS has been deprecated. - `:Next` is a core command, not termdebug plugin command. Termdebug uses `:Over` to send command `next` to gdb Solution: - Just use `pipx install pynvim` --- runtime/doc/api.txt | 12 +++++------- runtime/doc/if_pyth.txt | 2 +- runtime/doc/if_ruby.txt | 2 ++ runtime/doc/provider.txt | 4 ++-- runtime/doc/terminal.txt | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 97e25580a4..526cd62b1e 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -62,19 +62,17 @@ Nvim instance: #!/usr/bin/env ruby # Requires msgpack-rpc: gem install msgpack-rpc # - # To run this script, execute it from a running Nvim instance (notice the - # trailing '&' which is required since Nvim won't process events while - # running a blocking command): + # To run this script, use Nvim's built-in terminal emulator: # - # :!./hello.rb & + # :term ./hello.rb # - # Or from another shell by setting NVIM_LISTEN_ADDRESS: - # $ NVIM_LISTEN_ADDRESS=[address] ./hello.rb + # Or from another shell by setting NVIM: + # $ NVIM=[address] ./hello.rb require 'msgpack/rpc' require 'msgpack/rpc/transport/unix' - nvim = MessagePack::RPC::Client.new(MessagePack::RPC::UNIXTransport.new, ENV['NVIM_LISTEN_ADDRESS']) + nvim = MessagePack::RPC::Client.new(MessagePack::RPC::UNIXTransport.new, ENV['NVIM']) result = nvim.call(:nvim_command, 'echo "hello world!"') < A better way is to use the Python REPL with the "pynvim" package, where API diff --git a/runtime/doc/if_pyth.txt b/runtime/doc/if_pyth.txt index 81a92a3db5..2bdf3f0962 100644 --- a/runtime/doc/if_pyth.txt +++ b/runtime/doc/if_pyth.txt @@ -314,7 +314,7 @@ the list of paths found in 'runtimepath': with this directory in sys.path and vim.path_hooks in sys.path_hooks python will try to load module from {rtp}/python3 and {rtp}/pythonx for each {rtp} found in 'runtimepath'. -Implementation is similar to the following, but written in C: >python +Implementation is similar to the following: >python from imp import find_module, load_module import vim diff --git a/runtime/doc/if_ruby.txt b/runtime/doc/if_ruby.txt index ae5ab640f9..94669732a6 100644 --- a/runtime/doc/if_ruby.txt +++ b/runtime/doc/if_ruby.txt @@ -5,6 +5,8 @@ The Ruby Interface to Vim *if_ruby* *ruby* *Ruby* +See |provider-ruby| for more information. + *E266* *E267* *E268* *E269* *E270* *E271* *E272* *E273* The home page for ruby is https://www.ruby-lang.org/. You can find links for diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt index 721ea363e1..9887f17b7c 100644 --- a/runtime/doc/provider.txt +++ b/runtime/doc/provider.txt @@ -39,9 +39,9 @@ For Python 3 plugins: 2. Install either uv (https://docs.astral.sh/uv/) or pipx (https://pipx.pypa.io/stable/). 3. Install the module: >bash - uv tool install --upgrade pynvim + pipx install pynvim # or: - pipx install --upgrade pynvim + uv tool install --upgrade pynvim The `--upgrade` flag ensures that you get the latest version even if a previous version was already installed. diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt index b634c84d64..0f337fba8f 100644 --- a/runtime/doc/terminal.txt +++ b/runtime/doc/terminal.txt @@ -345,7 +345,7 @@ breakpoint was set. The line where the debugger stopped is highlighted. You can now step through the program. You will see the highlighting move as the debugger executes a line of source code. -Run ":Next" a few times until the for loop is highlighted. Put the cursor on +Run |:Over| a few times until the for loop is highlighted. Put the cursor on the end of "eap->arg", then call ":Eval". You will see this displayed: "eap->arg": 0x555555e68855 "gui" ~ This way you can inspect the value of local variables. You can also focus the