wea.split: Standardise comment

This commit is contained in:
Starbeamrainbowlabs 2021-05-29 22:49:14 +01:00
parent f7ecb84da4
commit 1e677c1f3f
Signed by: sbrl
GPG key ID: 1BE5172E637709C2

View file

@ -42,15 +42,12 @@ function worldeditadditions.gsplit(text, pattern, plain)
end end
-- split: split a string into substrings separated by a pattern. -- Split a string into substrings separated by a pattern.
-- -- @param text string The string to iterate over
-- Parameters: -- @param pattern string The separator pattern
-- text (string) - the string to iterate over -- @param plain boolean If true (or truthy), pattern is interpreted as a
-- pattern (string) - the separator pattern -- plain string, not a Lua pattern
-- plain (boolean) - if true (or truthy), pattern is interpreted as a plain -- @returns table A sequence table containing the substrings
-- string, not a Lua pattern
--
-- Returns: table (a sequence table containing the substrings)
function worldeditadditions.split(text, pattern, plain) function worldeditadditions.split(text, pattern, plain)
local ret = {} local ret = {}
for match in worldeditadditions.gsplit(text, pattern, plain) do for match in worldeditadditions.gsplit(text, pattern, plain) do