mirror of
https://github.com/neovim/neovim.git
synced 2025-09-11 22:08:18 +00:00
docs: fix misparsed headings (#24162)
Problem: vimdoc parser requires space between column heading and `~`. Solution: Add space to docs (and mention it). Also edit `luaref.txt` headings for consistency.
This commit is contained in:
@@ -280,7 +280,7 @@ nvim_buf_lines_event[{buf}, {changedtick}, {firstline}, {lastline}, {linedata},
|
|||||||
changed but not the buffer contents. {linedata} contains the changed
|
changed but not the buffer contents. {linedata} contains the changed
|
||||||
screen lines. This happens when 'inccommand' shows a buffer preview.
|
screen lines. This happens when 'inccommand' shows a buffer preview.
|
||||||
|
|
||||||
Properties:~
|
Properties: ~
|
||||||
{buf} API buffer handle (buffer number)
|
{buf} API buffer handle (buffer number)
|
||||||
|
|
||||||
{changedtick} value of |b:changedtick| for the buffer. If you send an
|
{changedtick} value of |b:changedtick| for the buffer. If you send an
|
||||||
@@ -313,7 +313,7 @@ nvim_buf_changedtick_event[{buf}, {changedtick}] *nvim_buf_changedtick_event*
|
|||||||
When |b:changedtick| was incremented but no text was changed. Relevant for
|
When |b:changedtick| was incremented but no text was changed. Relevant for
|
||||||
undo/redo.
|
undo/redo.
|
||||||
|
|
||||||
Properties:~
|
Properties: ~
|
||||||
{buf} API buffer handle (buffer number)
|
{buf} API buffer handle (buffer number)
|
||||||
{changedtick} new value of |b:changedtick| for the buffer
|
{changedtick} new value of |b:changedtick| for the buffer
|
||||||
|
|
||||||
@@ -326,7 +326,7 @@ nvim_buf_detach_event[{buf}] *nvim_buf_detach_event*
|
|||||||
|:checktime| or 'autoread'.
|
|:checktime| or 'autoread'.
|
||||||
- Generally: whenever the buffer contents are unloaded from memory.
|
- Generally: whenever the buffer contents are unloaded from memory.
|
||||||
|
|
||||||
Properties:~
|
Properties: ~
|
||||||
{buf} API buffer handle (buffer number)
|
{buf} API buffer handle (buffer number)
|
||||||
|
|
||||||
|
|
||||||
|
@@ -357,10 +357,11 @@ parameter, surround it in backticks, eg. `~/.path/to/init.vim`.
|
|||||||
|
|
||||||
HIGHLIGHTING
|
HIGHLIGHTING
|
||||||
|
|
||||||
To define a column heading, use a tilde character at the end of the line.
|
To define a column heading, use a tilde character at the end of the line,
|
||||||
This will highlight the column heading in a different color. E.g.
|
preceded by a space. This will highlight the column heading in a different
|
||||||
|
color. E.g.
|
||||||
|
|
||||||
Column heading~
|
Column heading ~
|
||||||
|
|
||||||
To separate sections in a help file, place a series of '=' characters in a
|
To separate sections in a help file, place a series of '=' characters in a
|
||||||
line starting from the first column. The section separator line is highlighted
|
line starting from the first column. The section separator line is highlighted
|
||||||
|
@@ -3830,7 +3830,7 @@ coroutine.yield({...}) *coroutine.yield()*
|
|||||||
to `yield` are passed as extra results to `resume`.
|
to `yield` are passed as extra results to `resume`.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
5.3 - Modules *luaref-libModule*
|
5.3 Modules *luaref-libModule*
|
||||||
|
|
||||||
The package library provides basic facilities for loading and building modules
|
The package library provides basic facilities for loading and building modules
|
||||||
in Lua. It exports two of its functions directly in the global environment:
|
in Lua. It exports two of its functions directly in the global environment:
|
||||||
@@ -3960,7 +3960,7 @@ package.seeall({module}) *package.seeall()*
|
|||||||
global environment. To be used as an option to function {module}.
|
global environment. To be used as an option to function {module}.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
5.4 - String Manipulation *luaref-libString*
|
5.4 String Manipulation *luaref-libString*
|
||||||
|
|
||||||
This library provides generic functions for string manipulation, such as
|
This library provides generic functions for string manipulation, such as
|
||||||
finding and extracting substrings, and pattern matching. When indexing a
|
finding and extracting substrings, and pattern matching. When indexing a
|
||||||
@@ -4199,9 +4199,8 @@ instance, `%S` represents all non-space characters.
|
|||||||
The definitions of letter, space, and other character groups depend on the
|
The definitions of letter, space, and other character groups depend on the
|
||||||
current locale. In particular, the class `[a-z]` may not be equivalent to `%l`.
|
current locale. In particular, the class `[a-z]` may not be equivalent to `%l`.
|
||||||
|
|
||||||
*luaref-patternitem*
|
PATTERN ITEM *luaref-patternitem*
|
||||||
Pattern Item:~
|
|
||||||
-------------
|
|
||||||
A pattern item may be
|
A pattern item may be
|
||||||
|
|
||||||
- a single character class, which matches any single character in the
|
- a single character class, which matches any single character in the
|
||||||
@@ -4226,17 +4225,15 @@ A pattern item may be
|
|||||||
`y` where the count reaches 0. For instance, the item `%b()` matches
|
`y` where the count reaches 0. For instance, the item `%b()` matches
|
||||||
expressions with balanced parentheses.
|
expressions with balanced parentheses.
|
||||||
|
|
||||||
*luaref-pattern*
|
PATTERN *luaref-pattern*
|
||||||
Pattern:~
|
|
||||||
--------
|
|
||||||
A pattern is a sequence of pattern items. A `^` at the beginning of a pattern
|
A pattern is a sequence of pattern items. A `^` at the beginning of a pattern
|
||||||
anchors the match at the beginning of the subject string. A `$` at the end of
|
anchors the match at the beginning of the subject string. A `$` at the end of
|
||||||
a pattern anchors the match at the end of the subject string. At other
|
a pattern anchors the match at the end of the subject string. At other
|
||||||
positions, `^` and `$` have no special meaning and represent themselves.
|
positions, `^` and `$` have no special meaning and represent themselves.
|
||||||
|
|
||||||
*luaref-capture*
|
CAPTURES *luaref-capture*
|
||||||
Captures:~
|
|
||||||
---------
|
|
||||||
A pattern may contain sub-patterns enclosed in parentheses; they describe
|
A pattern may contain sub-patterns enclosed in parentheses; they describe
|
||||||
captures. When a match succeeds, the substrings of the subject string that
|
captures. When a match succeeds, the substrings of the subject string that
|
||||||
match captures are stored (captured) for future use. Captures are numbered
|
match captures are stored (captured) for future use. Captures are numbered
|
||||||
|
@@ -48,7 +48,7 @@
|
|||||||
///
|
///
|
||||||
/// \brief For more information on buffers, see |buffers|
|
/// \brief For more information on buffers, see |buffers|
|
||||||
///
|
///
|
||||||
/// Unloaded Buffers:~
|
/// Unloaded Buffers: ~
|
||||||
///
|
///
|
||||||
/// Buffers may be unloaded by the |:bunload| command or the buffer's
|
/// Buffers may be unloaded by the |:bunload| command or the buffer's
|
||||||
/// |'bufhidden'| option. When a buffer is unloaded its file contents are freed
|
/// |'bufhidden'| option. When a buffer is unloaded its file contents are freed
|
||||||
|
Reference in New Issue
Block a user