mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-07 11:58:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

gen_vimdoc.py: mpack: exclude deprecated functions

Browse Source 
The `mpack` variable was a tuple, which manifests as an array in the
generated msgpack structure.
- Removes noise from the mpack data (deprecated functions are
  deprecated).
- Eliminates 1 level of nesting.

BEFORE:
    [
      {
        "buffer.c": [
          {
            "nvim__buf_stats": { ... },
            ...
          },
          {
            "buffer_del_line": { ... },
            ...
          },
        ],
        ...
      }
    ]

AFTER:
    [
      {
        "buffer.c": {
          "nvim__buf_stats": { ... },
          ...
        },
        ...
    ]
This commit is contained in:
Justin M. Keyes
2019-12-19 17:10:34 -08:00
parent 481da1ce40
commit 62e365f577
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/gen_vimdoc.py
View File

@@ -727,7 +727,7 @@ def gen_docs(config):
if p.returncode: if p.returncode:
sys.exit(p.returncode) sys.exit(p.returncode)
doc_maps = {} fn_maps = {}
sections = {} sections = {}
intros = {} intros = {}
sep = '=' * text_width sep = '=' * text_width
@@ -756,7 +756,7 @@ def gen_docs(config):
filename = get_text(find_first(compound, 'name')) filename = get_text(find_first(compound, 'name'))
if filename.endswith('.c') or filename.endswith('.lua'): if filename.endswith('.c') or filename.endswith('.lua'):
mpack = extract_from_xml(os.path.join(base, '{}.xml'.format( fn_map, _ = extract_from_xml(os.path.join(base, '{}.xml'.format(
compound.getAttribute('refid'))), mode, False) compound.getAttribute('refid'))), mode, False)
functions_text, deprecated_text, fns = fmt_doxygen_xml_as_vimhelp( functions_text, deprecated_text, fns = fmt_doxygen_xml_as_vimhelp(
@@ -798,7 +798,7 @@ def gen_docs(config):
title = '{} Functions'.format(name) title = '{} Functions'.format(name)
helptag = '*api-{}*'.format(name.lower()) helptag = '*api-{}*'.format(name.lower())
sections[filename] = (title, helptag, doc) sections[filename] = (title, helptag, doc)
doc_maps[filename] = mpack fn_maps[filename] = fn_map
if not sections: if not sections:
return return
@@ -831,7 +831,7 @@ def gen_docs(config):
fp.write(docs.encode('utf8')) fp.write(docs.encode('utf8'))
with open(mpack_file, 'wb') as fp: with open(mpack_file, 'wb') as fp:
fp.write(msgpack.packb(doc_maps, use_bin_type=True)) fp.write(msgpack.packb(fn_maps, use_bin_type=True))
shutil.rmtree(output_dir) shutil.rmtree(output_dir)