neovim

commit be2def41006f1f6395be546cc95c3ada32e7966a
parent 334a16c79113eec1cb9024a71631e1baa4473582
Author: Daiki Mizukami <tesaguriguma@gmail.com>
Date:   Sun, 13 Mar 2022 21:36:46 +0900

chore(gen_vimdoc): fall back to `brief_desc_node` when `desc_node` is empty

Diffstat:
M
runtime/doc/api.txt
 | 
3
++-
M
scripts/gen_vimdoc.py
 | 
6
+++++-

2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
@@ -594,7 +594,8 @@ nvim__id_float({flt})                                       *nvim__id_float()*
                     its argument.
 
 nvim__inspect_cell({grid}, {row}, {col})                *nvim__inspect_cell()*
-                TODO: Documentation
+                NB: if your UI doesn't use hlstate, this will not return
+                hlstate first time.
 
 nvim__runtime_inspect()                              *nvim__runtime_inspect()*
                 TODO: Documentation
diff --git a/scripts/gen_vimdoc.py b/scripts/gen_vimdoc.py
@@ -843,7 +843,9 @@ def extract_from_xml(filename, target, width):
             'seealso': [],
         }
         if fmt_vimhelp:
-            fn['desc_node'] = desc  # HACK :(
+            # HACK :(
+            fn['desc_node'] = desc
+            fn['brief_desc_node'] = brief_desc
 
         for m in paras:
             if 'text' in m:
@@ -891,6 +893,8 @@ def fmt_doxygen_xml_as_vimhelp(filename, target):
         # Generate Vim :help for parameters.
         if fn['desc_node']:
             doc = fmt_node_as_vimhelp(fn['desc_node'])
+        if not doc and fn['brief_desc_node']:
+            doc = fmt_node_as_vimhelp(fn['brief_desc_node'])
         if not doc:
             doc = 'TODO: Documentation'