steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated printf docs.

db4
John Benediktsson 2008-09-18 12:26:26 -07:00
parent 076d30b78f
commit 37aaaf1416
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
extra/printf/printf-docs.factor
View File

@ -9,19 +9,21 @@ HELP: printf
"Writes the arguments formatted according to the format string.\n" "Writes the arguments formatted according to the format string.\n"
{ $table { $table
{ "%%" "Single %" "" } { "%%" "Single %" "" }
{ "%Pd" "Integer format" "fixnum" }
{ "%P.De" "Scientific notation" "fixnum, float" }
{ "%P.DE" "Scientific notation" "fixnum, float" }
{ "%P.Df" "Fixed format" "fixnum, float" }
{ "%Px" "Hexadecimal" "hex" }
{ "%PX" "Hexadecimal uppercase" "hex" }
{ "%P.Ds" "String format" "string" } { "%P.Ds" "String format" "string" }
{ "%P.DS" "String format uppercase" "string" } { "%P.DS" "String format uppercase" "string" }
{ "%c" "Character format" "char" } { "%c" "Character format" "char" }
{ "%C" "Character format uppercase" "char" } { "%C" "Character format uppercase" "char" }
{ "%+Pd" "Integer format" "fixnum" }
{ "%+P.De" "Scientific notation" "fixnum, float" }
{ "%+P.DE" "Scientific notation" "fixnum, float" }
{ "%+P.Df" "Fixed format" "fixnum, float" }
{ "%+Px" "Hexadecimal" "hex" }
{ "%+PX" "Hexadecimal uppercase" "hex" }
} }
"\n" "\n"
"Padding ('P') is used to specify the minimum width of the result string, the padding character, and the alignment. By default, the padding character defaults to a space and the alignment defaults to right-aligned. For example:\n" "A plus sign ('+') is used to optionally specify that the number should be formatted with a '+' preceeding it if positive."
"\n"
"Padding ('P') is used to optionally specify the minimum width of the result string, the padding character, and the alignment. By default, the padding character defaults to a space and the alignment defaults to right-aligned. For example:\n"
{ $list { $list
"\"%5s\" formats a string padding with spaces up to 5 characters wide." "\"%5s\" formats a string padding with spaces up to 5 characters wide."
"\"%08d\" formats an integer padding with zeros up to 3 characters wide." "\"%08d\" formats an integer padding with zeros up to 3 characters wide."
@ -29,7 +31,7 @@ HELP: printf
"\"%-10d\" formats an integer to 10 characters wide and left-aligns." "\"%-10d\" formats an integer to 10 characters wide and left-aligns."
} }
"\n" "\n"
"Digits ('D') is used to specify the maximum digits in the result string. For example:\n" "Digits ('D') is used to optionally specify the maximum digits in the result string. For example:\n"
{ $list { $list
"\"%.3s\" formats a string to truncate at 3 characters (from the left)." "\"%.3s\" formats a string to truncate at 3 characters (from the left)."
"\"%.10f\" formats a float to pad-right with zeros up to 10 digits beyond the decimal point." "\"%.10f\" formats a float to pad-right with zeros up to 10 digits beyond the decimal point."
@ -57,6 +59,10 @@ HELP: printf
"USING: printf ;" "USING: printf ;"
"12 \"%'#4d\" printf" "12 \"%'#4d\" printf"
"##12" } "##12" }
{ $example
"USING: printf ;"
"1234 \"%+d\" printf"
"+1234" }
} ; } ;
HELP: sprintf HELP: sprintf