From 1e677c1f3f82cd8550b51d6075cb462639e1cfa5 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Sat, 29 May 2021 22:49:14 +0100 Subject: [PATCH] wea.split: Standardise comment --- worldeditadditions/utils/strings/split.lua | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/worldeditadditions/utils/strings/split.lua b/worldeditadditions/utils/strings/split.lua index 90e2b6d..69e5518 100644 --- a/worldeditadditions/utils/strings/split.lua +++ b/worldeditadditions/utils/strings/split.lua @@ -42,15 +42,12 @@ function worldeditadditions.gsplit(text, pattern, plain) end --- split: split a string into substrings separated by a pattern. --- --- Parameters: --- text (string) - the string to iterate over --- pattern (string) - the separator pattern --- plain (boolean) - if true (or truthy), pattern is interpreted as a plain --- string, not a Lua pattern --- --- Returns: table (a sequence table containing the substrings) +-- Split a string into substrings separated by a pattern. +-- @param text string The string to iterate over +-- @param pattern string The separator pattern +-- @param plain boolean If true (or truthy), pattern is interpreted as a +-- plain string, not a Lua pattern +-- @returns table A sequence table containing the substrings function worldeditadditions.split(text, pattern, plain) local ret = {} for match in worldeditadditions.gsplit(text, pattern, plain) do