add better docs to newer features

2025-09-23 23:33:01 -04:00
parent f63ab5820a
commit 281c6c7112
3 changed files with 6 additions and 0 deletions
@@ -54,6 +54,7 @@ function core.fileContainsWorkspace(fileContents: string, opts: types.opts): boo
    return core.scanForWorkspace(instances, opts.printInstanceNames)
 end

+-- formats the workspace detection result as a colored string
 function core.formatResult(result: boolean, fileName: string): string
    assert(typeof(result) == "boolean", "Expected result to be of type 'boolean'")
    assert(typeof(fileName) == "string", "Expected fileName to be of type 'string'")