docs: misc

Close #38748
Close #38866

Co-authored-by: Mario Loriedo <mario.loriedo@gmail.com>
Co-authored-by: Anakin Childerhose <anakin@childerhose.ca>
This commit is contained in:
Justin M. Keyes
2026-04-06 02:29:39 +02:00
parent 2f6c560002
commit a321c9adad
17 changed files with 124 additions and 63 deletions

View File

@@ -6757,8 +6757,8 @@ vim.wo.stc = vim.wo.statuscolumn
--- ```
---
--- All fields except {item} are optional. Use "%%" to show a literal "%"
--- char. Setting this option to empty (`:set statusline=`) sets its
--- value to the default.
--- char. Setting to empty (`:set statusline=`) sets the global value to
--- the default.
---
--- *stl-%!*
--- When the option starts with "%!" then it is used as an expression,

View File

@@ -3273,7 +3273,7 @@ function vim.fn.getfperm(fname) end
--- @return integer
function vim.fn.getfsize(fname) end
--- Returns the last modification time of the given file {fname}.
--- Returns the last modification time ("mtime") of file {fname}.
--- The value is measured as seconds since 1st Jan 1970, and may
--- be passed to |strftime()|. See also
--- |localtime()| and |strftime()|.

View File

@@ -15,9 +15,8 @@ local M = {}
---Buffer to save the response body to.
---@field outbuf? integer
---
---Table of custom headers to send with the request.
---Supports basic key/value header formats and empty headers as supported by curl.
---Does not support @filename style, internal header deletion (e.g: 'Header:').
---Custom headers to send with the request. Supports basic key/value headers and empty headers as
---supported by curl. Does not support "@filename" style, internal header deletion ("Header:").
---@field headers? table<string, string>
---@class vim.net.request.Response
@@ -30,12 +29,12 @@ local M = {}
---
--- Examples:
--- ```lua
--- -- Write response body to file
--- -- Write response body to file.
--- vim.net.request('https://neovim.io/charter/', {
--- outpath = 'vision.html',
--- })
---
--- -- Process the response
--- -- Process the response.
--- vim.net.request(
--- 'https://api.github.com/repos/neovim/neovim',
--- {},
@@ -46,14 +45,14 @@ local M = {}
--- end
--- )
---
--- -- Write to both file and current buffer, but cancel it
--- -- Write to both file and current buffer, but cancel it.
--- local job = vim.net.request('https://neovim.io/charter/', {
--- outpath = 'vision.html',
--- outbuf = 0,
--- })
--- job:close()
---
--- -- Add custom headers in the request
--- -- Add custom headers in the request.
--- vim.net.request('https://neovim.io/charter/', {
--- headers = { Authorization = 'Bearer XYZ' },
--- })
@@ -64,7 +63,7 @@ local M = {}
--- @param on_response? fun(err: string?, response: vim.net.request.Response?)
--- Callback invoked on request completion. The `body` field in the response
--- parameter contains the raw response data (text or binary).
--- @return { close: fun() } # Table with method to cancel, similar to [vim.SystemObj].
--- @return { close: fun() } # Object with `close()` method which cancels the request.
function M.request(url, opts, on_response)
vim.validate('url', url, 'string')
vim.validate('opts', opts, 'table', true)