diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-01-26 20:10:59 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2019-01-26 20:38:14 +0100 |
| commit | cd64f5abd46e24509b8650f7ecfa30d3f0152b0e (patch) | |
| tree | 58c7ce58ac45f2d3f5daad8432f6a2af8f568f7d | |
| parent | c70c8b607f84611373969d3add2f6ef25e61078f (diff) | |
| download | rneovim-cd64f5abd46e24509b8650f7ecfa30d3f0152b0e.tar.gz rneovim-cd64f5abd46e24509b8650f7ecfa30d3f0152b0e.tar.bz2 rneovim-cd64f5abd46e24509b8650f7ecfa30d3f0152b0e.zip | |
gen_api_vimdoc.py: Do not wrap on hyphens, long words
- Any long symbol is intentional and should never be hardwrapped.
- Vim help tags are often hyphenated, and hardwrapping on hyphens breaks
the Vim help syntax parser.
| -rw-r--r-- | runtime/doc/api.txt | 12 | ||||
| -rwxr-xr-x | scripts/gen_api_vimdoc.py | 9 |
2 files changed, 12 insertions, 9 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 1d2764b9ee..658e81689b 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -291,8 +291,8 @@ nvim_input({keys}) *nvim_input()* Note: For mouse events use |nvim_input_mouse()|. The pseudokey - form "<LeftMouse><col,row>" is deprecated since |api- - level| 6. + form "<LeftMouse><col,row>" is deprecated since + |api-level| 6. Attributes: ~ {async} @@ -1254,8 +1254,8 @@ nvim_buf_set_virtual_text({buffer}, {ns_id}, {line}, {chunks}, {opts}) By default (and currently the only option) the text will be placed after the buffer text. Virtual text will never cause reflow, rather virtual text will be truncated at the end of - the screen line. The virtual text will begin one cell (|lcs- - eol| or space) after the ordinary text. + the screen line. The virtual text will begin one cell + (|lcs-eol| or space) after the ordinary text. Namespaces are used to support batch deletion/updating of virtual text. To create a namespace, use @@ -1274,8 +1274,8 @@ nvim_buf_set_virtual_text({buffer}, {ns_id}, {line}, {chunks}, {opts}) {buffer} Buffer handle {ns_id} Namespace to use or 0 to create a namespace, or -1 for a ungrouped annotation - {line} Line to annotate with virtual text (zero- - indexed) + {line} Line to annotate with virtual text + (zero-indexed) {chunks} A list of [text, hl_group] arrays, each representing a text chunk with specified highlight. `hl_group` element can be omitted for diff --git a/scripts/gen_api_vimdoc.py b/scripts/gen_api_vimdoc.py index 4e86f15b37..515964bfe8 100755 --- a/scripts/gen_api_vimdoc.py +++ b/scripts/gen_api_vimdoc.py @@ -158,9 +158,12 @@ def doc_wrap(text, prefix='', width=70, func=False): lines[-1] += part return '\n'.join(x.rstrip() for x in lines).rstrip() - return '\n'.join(textwrap.wrap(text.strip(), width=width, - initial_indent=prefix, - subsequent_indent=indent_space)) + tw = textwrap.TextWrapper(break_long_words = False, + break_on_hyphens = False, + width=width, + initial_indent=prefix, + subsequent_indent=indent_space) + return '\n'.join(tw.wrap(text.strip())) def parse_params(parent, width=62): |