plenary.nvim icon indicating copy to clipboard operation
plenary.nvim copied to clipboard

test coverage, missing usage hints with tests or documentation

Open matu3ba opened this issue 4 years ago • 3 comments

As of now there is no test coverage, ie with luacov.

Further I noticed the following files have no test coverage and neither documentation in the README:

  1. benchmark
  2. bit
  3. fun, functional and operators
  4. debug_utils
  5. log
  6. debug_utils
  7. reload

matu3ba avatar Oct 03 '21 21:10 matu3ba

I wanted to set it up some time ago: https://github.com/nvim-lua/plenary.nvim/pull/71#issuecomment-824269980

We could add actual support for plenary.busted. To make the setup for other plugin devs easier. Thinking about it

Conni2461 avatar Oct 04 '21 19:10 Conni2461

Also i dont think we need to mention every module in the README. We should setup tree-sitter-lua docgen for plenary as well and just generate vimdoc.

Btw bit just exists because it doesnt exist in lua5.1 https://github.com/nvim-lua/plenary.nvim/blob/6bb0e09030a7c2af19bf288088ca815228de9429/lua/plenary/bit.lua#L1-L2

Conni2461 avatar Oct 04 '21 19:10 Conni2461