mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-11-17 15:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): markdown instead of vimdoc in meta docstrings #30680

Browse Source 
LuaLS/meta docstrings expect markdown, not vimdoc. This matters for lists, codeblocks, etc.

Also, line length doesn't matter for docstrings.
This commit is contained in:
Justin M. Keyes
2024-10-06 03:24:21 -07:00
committed by GitHub
parent a2008118a0
commit 056009f741
3 changed files with 900 additions and 975 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
scripts/util.lua
View File

@@ -175,15 +175,16 @@ end
--- Prefixes each line in `text`.
---
--- Does not wrap, that's not important for "meta" files? (You probably want md_to_vimdoc instead.)
--- Does not wrap, not important for "meta" files? (You probably want md_to_vimdoc instead.)
---
--- @param text string
--- @param prefix_ string
function M.prefix(prefix_, text)
if (text):find('\n$') then
return text:gsub('([^\n]*)[\t ]*\n', prefix_ .. '%1\n')
function M.prefix_lines(prefix_, text)
local r = ''
for _, l in ipairs(vim.split(text, '\n', { plain = true })) do
r = r .. vim.trim(prefix_ .. l) .. '\n'
end
return prefix_ .. text:gsub('([^\n]*)[\t ]*\n', '%1\n' .. prefix_)
return r
end
--- @param x string