mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-10 04:57:00 -04:00
spellchecking the documentation
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1277 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
@@ -8,17 +8,19 @@ DOC_MSE_VERSION: since 0.3.7
|
||||
Convert any value to a [[type:string]] representation.
|
||||
|
||||
|
||||
The @to_string@ function should not be confused with @to_text@,
|
||||
the former converts things like number to string, while the latter removes tags from a [[type:tagged string]].
|
||||
The @to_string@ function should not be confused with @to_text@.
|
||||
The former converts things like number to string, while the latter removes tags from a [[type:tagged string]].
|
||||
|
||||
--Parameters--
|
||||
! Parameter Type Description
|
||||
| @input@ ''any type'' Value to convert to a string
|
||||
| @format@ ''optional'' Formating to apply.
|
||||
| @format@ ''optional'' Formatting to apply.<br/>
|
||||
This takes the same form as [[http://www.cplusplus.com/reference/clibrary/cstdio/printf.html|printf format specifiers]].
|
||||
|
||||
--Examples--
|
||||
> to_string(to_color("blue")) == "rgb(0,0,255)"
|
||||
> to_string(10 + 20) == "30"
|
||||
> to_string(10 + 20, format: ".3f") == "30.000"
|
||||
> to_string(10 + 20, format: "x") == "1e" # hexadecimal notation
|
||||
> to_string("xy", format: "3s") == " xy"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user