mirror of
				https://github.com/neovim/neovim.git
				synced 2025-11-04 01:34:25 +00:00 
			
		
		
		
	docs: small fixes (#25585)
Co-authored-by: tmummert <doczook@gmx.de> Co-authored-by: parikshit adhikari <parikshitadhikari@gmail.com>
This commit is contained in:
		@@ -3161,7 +3161,7 @@ nvim_open_win({buffer}, {enter}, {*config})                  *nvim_open_win()*
 | 
			
		||||
                    • "shadow": A drop shadow effect by blending with the
 | 
			
		||||
                      background.
 | 
			
		||||
                    • If it is an array, it should have a length of eight or
 | 
			
		||||
                      any divisor of eight. The array will specifify the eight
 | 
			
		||||
                      any divisor of eight. The array will specify the eight
 | 
			
		||||
                      chars building up the border in a clockwise fashion
 | 
			
		||||
                      starting with the top-left corner. As an example, the
 | 
			
		||||
                      double box style could be specified as [ "╔", "═" ,"╗",
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								runtime/doc/builtin.txt
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								runtime/doc/builtin.txt
									
									
									
										generated
									
									
									
								
							@@ -7187,7 +7187,7 @@ sockconnect({mode}, {address} [, {opts}])                        *sockconnect()*
 | 
			
		||||
		{address} should be the path of a local domain socket (on
 | 
			
		||||
		unix) or named pipe (on Windows). If {mode} is "tcp" then
 | 
			
		||||
		{address} should be of the form "host:port" where the host
 | 
			
		||||
		should be an ip adderess or host name, and port the port
 | 
			
		||||
		should be an ip address or host name, and port the port
 | 
			
		||||
		number.
 | 
			
		||||
 | 
			
		||||
		For "pipe" mode, see |luv-pipe-handle|. For "tcp" mode, see
 | 
			
		||||
 
 | 
			
		||||
@@ -117,7 +117,7 @@ simple example, echoing some data through a cat-process:
 | 
			
		||||
    call chansend(id, "hello!")
 | 
			
		||||
<
 | 
			
		||||
 | 
			
		||||
Here is a example of setting a buffer to the result of grep, but only after
 | 
			
		||||
Here is an example of setting a buffer to the result of grep, but only after
 | 
			
		||||
all data has been processed:
 | 
			
		||||
>vim
 | 
			
		||||
    function! s:OnEvent(id, data, event) dict
 | 
			
		||||
 
 | 
			
		||||
@@ -276,7 +276,6 @@ g:rust_keep_autopairs_default ~
 | 
			
		||||
 | 
			
		||||
	Don't override auto-pairs default for the Rust filetype. The default
 | 
			
		||||
	is 0.
 | 
			
		||||
 
 | 
			
		||||
 | 
			
		||||
==============================================================================
 | 
			
		||||
COMMANDS                                                       *rust-commands*
 | 
			
		||||
 
 | 
			
		||||
@@ -137,7 +137,7 @@ backslash.  To include a backslash you have to use two.  Effectively this
 | 
			
		||||
means that the number of backslashes in an option value is halved (rounded
 | 
			
		||||
down).
 | 
			
		||||
In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
 | 
			
		||||
backslashes instead becuase they can be separated by either commas or spaces.
 | 
			
		||||
backslashes instead because they can be separated by either commas or spaces.
 | 
			
		||||
Comma-separated options like 'backupdir' and 'tags' will also require commas
 | 
			
		||||
to be escaped with two backslashes, whereas this is not needed for
 | 
			
		||||
non-comma-separated ones like 'makeprg'.
 | 
			
		||||
 
 | 
			
		||||
@@ -1307,7 +1307,7 @@ exactly four MessagePack objects:
 | 
			
		||||
   10 (LocalMark)
 | 
			
		||||
   11 (Change)         Map containing some position description:
 | 
			
		||||
                       Entry      Position ~
 | 
			
		||||
                       GlobaMark  Global mark position. |'A|
 | 
			
		||||
                       GlobalMark Global mark position. |'A|
 | 
			
		||||
                       LocalMark  Local mark position. |'a|
 | 
			
		||||
                       Jump       One position from the |jumplist|.
 | 
			
		||||
                       Change     One position from the |changelist|.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								runtime/lua/vim/_meta/api.lua
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								runtime/lua/vim/_meta/api.lua
									
									
									
										generated
									
									
									
								
							@@ -1594,7 +1594,7 @@ function vim.api.nvim_open_term(buffer, opts) end
 | 
			
		||||
---                 • "shadow": A drop shadow effect by blending with the
 | 
			
		||||
---                   background.
 | 
			
		||||
---                 • If it is an array, it should have a length of eight or
 | 
			
		||||
---                   any divisor of eight. The array will specifify the eight
 | 
			
		||||
---                   any divisor of eight. The array will specify the eight
 | 
			
		||||
---                   chars building up the border in a clockwise fashion
 | 
			
		||||
---                   starting with the top-left corner. As an example, the
 | 
			
		||||
---                   double box style could be specified as [ "╔", "═" ,"╗",
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								runtime/lua/vim/_meta/vimfn.lua
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								runtime/lua/vim/_meta/vimfn.lua
									
									
									
										generated
									
									
									
								
							@@ -8530,7 +8530,7 @@ function vim.fn.slice(expr, start, end_) end
 | 
			
		||||
--- {address} should be the path of a local domain socket (on
 | 
			
		||||
--- unix) or named pipe (on Windows). If {mode} is "tcp" then
 | 
			
		||||
--- {address} should be of the form "host:port" where the host
 | 
			
		||||
--- should be an ip adderess or host name, and port the port
 | 
			
		||||
--- should be an ip address or host name, and port the port
 | 
			
		||||
--- number.
 | 
			
		||||
---
 | 
			
		||||
--- For "pipe" mode, see |luv-pipe-handle|. For "tcp" mode, see
 | 
			
		||||
 
 | 
			
		||||
@@ -359,7 +359,7 @@ void nvim_buf_set_lines(uint64_t channel_id, Buffer buffer, Integer start, Integ
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // loaded buffer first if it's not loaded
 | 
			
		||||
  // load buffer first if it's not loaded
 | 
			
		||||
  if (buf->b_ml.ml_mfp == NULL) {
 | 
			
		||||
    if (!buf_ensure_loaded(buf)) {
 | 
			
		||||
      api_set_error(err, kErrorTypeException, "Failed to load buffer");
 | 
			
		||||
@@ -541,7 +541,7 @@ void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, In
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // loaded buffer first if it's not loaded
 | 
			
		||||
  // load buffer first if it's not loaded
 | 
			
		||||
  if (buf->b_ml.ml_mfp == NULL) {
 | 
			
		||||
    if (!buf_ensure_loaded(buf)) {
 | 
			
		||||
      api_set_error(err, kErrorTypeException, "Failed to load buffer");
 | 
			
		||||
 
 | 
			
		||||
@@ -135,7 +135,7 @@
 | 
			
		||||
///     - "solid": Adds padding by a single whitespace cell.
 | 
			
		||||
///     - "shadow": A drop shadow effect by blending with the background.
 | 
			
		||||
///     - If it is an array, it should have a length of eight or any divisor of
 | 
			
		||||
///     eight. The array will specifify the eight chars building up the border
 | 
			
		||||
///     eight. The array will specify the eight chars building up the border
 | 
			
		||||
///     in a clockwise fashion starting with the top-left corner. As an
 | 
			
		||||
///     example, the double box style could be specified as
 | 
			
		||||
///       [ "╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ].
 | 
			
		||||
 
 | 
			
		||||
@@ -3396,10 +3396,9 @@ linenr_T diff_lnum_win(linenr_T lnum, win_T *wp)
 | 
			
		||||
  return n;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
///
 | 
			
		||||
/// Handle an ED style diff line.
 | 
			
		||||
/// Return FAIL if the line does not contain diff info.
 | 
			
		||||
///
 | 
			
		||||
/// @return  FAIL if the line does not contain diff info.
 | 
			
		||||
static int parse_diff_ed(char *line, diffhunk_T *hunk)
 | 
			
		||||
{
 | 
			
		||||
  int l1, l2;
 | 
			
		||||
 
 | 
			
		||||
@@ -10184,7 +10184,7 @@ M.funcs = {
 | 
			
		||||
      {address} should be the path of a local domain socket (on
 | 
			
		||||
      unix) or named pipe (on Windows). If {mode} is "tcp" then
 | 
			
		||||
      {address} should be of the form "host:port" where the host
 | 
			
		||||
      should be an ip adderess or host name, and port the port
 | 
			
		||||
      should be an ip address or host name, and port the port
 | 
			
		||||
      number.
 | 
			
		||||
 | 
			
		||||
      For "pipe" mode, see |luv-pipe-handle|. For "tcp" mode, see
 | 
			
		||||
 
 | 
			
		||||
@@ -771,7 +771,7 @@ void grid_put_linebuf(ScreenGrid *grid, int row, int coloff, int col, int endcol
 | 
			
		||||
      ui_line(grid, row, start_pos, coloff + end_dirty, coloff + clear_end,
 | 
			
		||||
              bg_attr, wrap);
 | 
			
		||||
    } else if (grid->dirty_col) {
 | 
			
		||||
      // TODO(bfredl): really get rid of the extra psuedo terminal in message.c
 | 
			
		||||
      // TODO(bfredl): really get rid of the extra pseudo terminal in message.c
 | 
			
		||||
      // by using a linebuf_char copy for "throttled message line"
 | 
			
		||||
      if (clear_end > grid->dirty_col[row]) {
 | 
			
		||||
        grid->dirty_col[row] = clear_end;
 | 
			
		||||
 
 | 
			
		||||
@@ -36,7 +36,7 @@ EXTERN colnr_T *linebuf_vcol INIT( = NULL);
 | 
			
		||||
/// Put a ASCII character in a screen cell.
 | 
			
		||||
///
 | 
			
		||||
/// If `x` is a compile time constant, schar_from_ascii(x) will also be.
 | 
			
		||||
/// But the specific value varies per plattform.
 | 
			
		||||
/// But the specific value varies per platform.
 | 
			
		||||
#ifdef ORDER_BIG_ENDIAN
 | 
			
		||||
# define schar_from_ascii(x) ((schar_T)((x) << 24))
 | 
			
		||||
#else
 | 
			
		||||
 
 | 
			
		||||
@@ -880,7 +880,7 @@ int get_mouse_button(int code, bool *is_click, bool *is_drag)
 | 
			
		||||
///                    REPTERM_DO_LT        also translate <lt>
 | 
			
		||||
///                    REPTERM_NO_SPECIAL   do not accept <key> notation
 | 
			
		||||
///                    REPTERM_NO_SIMPLIFY  do not simplify <C-H> into 0x08, etc.
 | 
			
		||||
/// @param[out]  did_simplify  set when some <C-H> code was simplied, unless it is NULL.
 | 
			
		||||
/// @param[out]  did_simplify  set when some <C-H> code was simplified, unless it is NULL.
 | 
			
		||||
/// @param[in]  cpo_flags  Relevant flags derived from p_cpo, see CPO_TO_CPO_FLAGS.
 | 
			
		||||
///
 | 
			
		||||
/// @return  The same as what `*bufp` is set to.
 | 
			
		||||
 
 | 
			
		||||
@@ -6,7 +6,7 @@
 | 
			
		||||
// `String key` lookup keys don't need to be NULL terminated, but they
 | 
			
		||||
// must not contain embedded NUL:s. When reading a key from set->keys, they
 | 
			
		||||
// are always NUL terminated, though. Thus, it is enough to store an index into
 | 
			
		||||
// this array, and use strlen(), to retrive an interned key.
 | 
			
		||||
// this array, and use strlen(), to retrieve an interned key.
 | 
			
		||||
 | 
			
		||||
#include <assert.h>
 | 
			
		||||
#include <stdbool.h>
 | 
			
		||||
 
 | 
			
		||||
@@ -74,7 +74,7 @@ char *get_mess_lang(void)
 | 
			
		||||
/// Get the language used for messages from the environment.
 | 
			
		||||
///
 | 
			
		||||
/// This uses LC_MESSAGES when available, which it is for most systems we build for
 | 
			
		||||
/// except for windows. Then fallback to get the value from the envirionment
 | 
			
		||||
/// except for windows. Then fallback to get the value from the environment
 | 
			
		||||
/// ourselves, and use LC_CTYPE as a last resort.
 | 
			
		||||
static char *get_mess_env(void)
 | 
			
		||||
{
 | 
			
		||||
 
 | 
			
		||||
@@ -1333,7 +1333,7 @@ describe('autocmd api', function()
 | 
			
		||||
      local without_group = meths.get_autocmds(search)
 | 
			
		||||
      eq(2, #without_group)
 | 
			
		||||
 | 
			
		||||
      -- Doest clear with passing group.
 | 
			
		||||
      -- Doesn't clear with passing group.
 | 
			
		||||
      meths.clear_autocmds { buffer = 0, group = search.group }
 | 
			
		||||
      local with_group = meths.get_autocmds(search)
 | 
			
		||||
      eq(1, #with_group)
 | 
			
		||||
 
 | 
			
		||||
@@ -884,7 +884,7 @@ describe('smoothscroll', function()
 | 
			
		||||
  end)
 | 
			
		||||
 | 
			
		||||
  -- oldtest: Test_smoothscroll_multi_skipcol()
 | 
			
		||||
  it('scrolling mulitple lines and stopping at non-zero skipcol', function()
 | 
			
		||||
  it('scrolling multiple lines and stopping at non-zero skipcol', function()
 | 
			
		||||
    screen:try_resize(40, 10)
 | 
			
		||||
    screen:set_default_attr_ids({
 | 
			
		||||
      [0] = {foreground = Screen.colors.Blue, bold = true},
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user