Skip to content

docs(test): fix several typos - #2590

Merged
echasnovski merged 1 commit into
nvim-mini:mainfrom
abeldekat:mini_docs_test
Oct 25, 2026
Merged

echasnovski merged 1 commit into
nvim-mini:mainfrom
abeldekat:mini_docs_test

Conversation

@abeldekat

Copy link
Copy Markdown
Member

Whilst reading both docs and code, I found some typos.
There is a part I found confusing:

---     - `child.api.nvim_buf_line_count(0)` will execute
---       `vim.api.nvim_buf_line_count(0)` inside child process and return its

It does not execute vim.api.nvim_buf_line_count(0) literally. Perhaps:

---     - `child.api.nvim_buf_line_count(0)` will execute
---       `nvim_buf_line_count(0)`(see `:h api`) inside child process and return its

@abeldekat
abeldekat requested a review from echasnovski October 25, 2026 08:16
@abeldekat abeldekat added documentation Improvements or additions to documentation mini.test labels Oct 25, 2026
Comment thread doc/mini-test.txt Outdated
case of a doubt, use `child.lua()`.
- Almost all methods use |vim.rpcrequest()| (i.e. wait for call to finish and
then return value). See for `*_notify` variant to use |vim.rpcnotify()|.
then return value). For `*_notify` variants see |vim.rpcnotify()|.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the meaning, though. The intended message is "If there is a *_notify method, it uses |vim.rpcnotify()|". If this is more understandable, then let's use it. If not, let's keep as is.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's better. Would you consider:

In a `*_notify` variant |vim.rpcnotify()| is used.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, sounds good as long as it fits the same line (which it does).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@echasnovski

Copy link
Copy Markdown
Member

There is a part I found confusing:

---     - `child.api.nvim_buf_line_count(0)` will execute
---       `vim.api.nvim_buf_line_count(0)` inside child process and return its

Indeed it is not quite child.lua('vim.api.nvim_buf_line_count(0)'), but the Lua form is more understandable than using the API. If it will make it clearer, maybe replace "will execute" with "will act as if"?

@echasnovski echasnovski left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@echasnovski
echasnovski merged commit d79805a into nvim-mini:main Oct 25, 2026
12 checks passed
@abeldekat
abeldekat deleted the mini_docs_test branch October 25, 2026 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation mini.test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants