Repository: neovim/neovim
File: src/nvim/eval.lua (Lua)

Code before:
      	let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
      <In this example "submatch" is 2 when a lowercase letter is
      found |/\l|, 3 when an uppercase letter is found |/\u|.

    ]=],
    name = 'searchpos',
    params = {
      { 'pattern', 'string' },
      { 'flags', 'string' },
      { 'stopline', 'integer' },
      { 'timeout', 'integer' },
      { 'skip', 'string|function' },
    },
    signature = 'searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])',
  },
  serverlist = {
    args = { 0, 1 },
    desc = [=[
      Returns a list of server addresses, or empty if all servers
      were stopped. |serverstart()| |serverstop()|

      The optional argument {opts} is a Dict and supports the following items:

        peer  : If |TRUE|, servers not started by |serverstart()| will also be returned.
                Currenly only supports unnamed pipes in stdpath("run").
                (default: |FALSE|)

      Example: >vim
      	echo serverlist()
      <
    ]=],
    name = 'serverlist',
    params = { { 'opts', 'table' } },
    returns = 'string[]',
    signature = 'serverlist()',
  },
  serverstart = {
    args = { 0, 1 },
    desc = [=[
      Opens a socket or named pipe at {address} and listens for
      |RPC| messages. Clients can send |API| commands to the
      returned address to control Nvim.

      Returns the address string (which may differ from the
      {address} argument, see below).

      - If {address} has a colon (":") it is a TCP/IPv4/IPv6 address
        where the last ":" separates host and port (empty or zero
        assigns a random port).
      - Else {address} is the path to a named pipe (except on Windows).
        - If {address} has no slashes ("/") it is treated as the

Review comment (suggestion):
```suggestion
        peer  : If |TRUE|, servers not started by |serverstart()|
                will also be returned. Currenly only supports
                unnamed pipes in stdpath("run"). (default: |FALSE|)
```

Code after:
      the sub-pattern match number |search()-sub-match|.  Example: >vim
      	let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
      <In this example "submatch" is 2 when a lowercase letter is
      found |/\l|, 3 when an uppercase letter is found |/\u|.

    ]=],
    name = 'searchpos',
    params = {
      { 'pattern', 'string' },
      { 'flags', 'string' },
      { 'stopline', 'integer' },
      { 'timeout', 'integer' },
      { 'skip', 'string|function' },
    },
    signature = 'searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])',
  },
  serverlist = {
    args = { 0, 1 },
    desc = [=[
      Returns a list of server addresses, or empty if all servers
      were stopped. |serverstart()| |serverstop()|

      The optional argument {opts} is a Dict and supports the following items:

        peer  : If |TRUE|, servers not started by |serverstart()| 
                will also be returned. (default: |FALSE|)
                Not supported on Windows yet.

      Example: >vim
      	echo serverlist()
      <
    ]=],
    name = 'serverlist',
    params = { { 'opts', 'table' } },
    returns = 'string[]',
    signature = 'serverlist([{opts}])',
  },
  serverstart = {
    args = { 0, 1 },
    desc = [=[
      Opens a socket or named pipe at {address} and listens for
      |RPC| messages. Clients can send |API| commands to the
      returned address to control Nvim.

      Returns the address string (which may differ from the
      {address} argument, see below).

      - If {address} has a colon (":") it is a TCP/IPv4/IPv6 address
        where the last ":" separates host and port (empty or zero
        assigns a random port).
      - Else {address} is the path to a named pipe (except on Windows).