darktable/lua-scripts-w-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #466 from wpferguson/more_string_doc_updates

Browse Source 
lib/dtutils/string - more embedded doc updates
This commit is contained in:
wpferguson
2024-05-20 23:45:07 -04:00
committed by GitHub
parent cbe2c5329a fecbb39347
commit c36618f5fb
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/dtutils/string.lua
View File

@@ -1029,7 +1029,7 @@ end
dtutils_string.libdoc.functions["substitute"] = {
Name = [[substitute]],
Synopsis = [[Check if a string has been sanitized]],
Synopsis = [[Perform all the variable substitution steps with one function call]],
Usage = [[local ds = require "lib/dtutils.string"
ds.substitute(image, sequence, variable_string, [username], [pic_folder], [home], [desktop])
image - dt_lua_image_t - the image being processed
@@ -1040,7 +1040,7 @@ dtutils_string.libdoc.functions["substitute"] = {
[home] - string - optional - home directory. Will be determined if not supplied
[desktop] - string - optional - desktop directory. Will be determined if not supplied]],
Description = [[substitute initializes the substitution list by calling clear_substitute_list(),
then builds the substitutions by calling build_substitution_list() and finally does the
then builds the substitutions by calling build_substitute_list() and finally does the
substitution by calling substitute_list(), then returns the result string.]],
Return_Value = [[result - string - the input string with values substituted for the variables]],
Limitations = [[]],