kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

gen_api_vimdoc.py: Do not wrap on hyphens, long words

Browse Source 
- 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.
This commit is contained in:
Justin M. Keyes 2019-01-26 20:10:59 +01:00
parent c70c8b607f
commit cd64f5abd4
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
runtime/doc/api.txt
View File

@ -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

9
scripts/gen_api_vimdoc.py
View File

@ -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):