chore(doc): improve help by allowing accessing nested options (#1246)

2022-05-09 08:59:09 +02:00
parent 9049f364cc
commit 47732b6dbf
2 changed files with 228 additions and 246 deletions
--- a/README.md
+++ b/README.md
@@ -115,6 +115,7 @@ require'nvim-tree'.setup {

 -- setup with all defaults
 -- each of these are documented in `:help nvim-tree.OPTION_NAME`
+-- nested options are documented by accessing them with `.` (eg: `:help nvim-tree.view.mappings.list`).
 require'nvim-tree'.setup { -- BEGIN_DEFAULT_OPTS
  auto_reload_on_write = true,
  disable_netrw = false,