nvim-neotest / nvim-nio

A library for asynchronous IO in Neovim
MIT License
288 stars 8 forks source link

[DOC] Please make separate (sub) section for each functionality. #8

Closed pysan3 closed 7 months ago

pysan3 commented 8 months ago

In the current README, all explanation of nio.* classes are provided as simple paragraphs.

As per the limitation on GitHub, only sections are provided with a link (eg https://github.com/nvim-neotest/nvim-nio#usage ).

I would appreciate if it would be possible to make the feature paragraphs their own distinct sections, such as ### nio.control.

Thanks in advance ;)

pysan3 commented 7 months ago

@rcarriga

Unrelated but,

How should I describe to be inside a nio.run?

nio.run(function ()
  -- inside a <???>
  -- - an asynchronous environment?
  -- - a nio task?
  -- - a nio job?
  -- - a nio environment?
  -- - a nio run?
end)
rcarriga commented 7 months ago

Good question :sweat_smile: I refer to them as "async contexts" in the docs and error messages.

pysan3 commented 7 months ago

Ah, nice. Thanks ;)