Added documentation for Kernel#sprintf method (#5914)

Fixes #3124
crystal-lang · Apr 13, 2018 · 24c5330 · 24c5330
1 parent 35a108e
commit 24c5330
Show file tree

Hide file tree

Showing 2 changed files with 222 additions and 2 deletions.
diff --git a/src/io.cr b/src/io.cr
@@ -281,6 +281,8 @@ abstract class IO
     nil
   end
 
+  # Writes a formatted string to this IO.
+  # For details on the format string, see `Kernel::sprintf`.
   def printf(format_string, *args) : Nil
     printf format_string, args
   end

diff --git a/src/kernel.cr b/src/kernel.cr
@@ -57,7 +57,7 @@ end
 
 # Prints a formatted string to `STDOUT`.
 #
-# See also: `IO#printf`.
+# For details on the format string, see `sprintf`.
 def printf(format_string, *args) : Nil
   printf format_string, args
 end
@@ -68,8 +68,226 @@ def printf(format_string, args : Array | Tuple) : Nil
 end
 
 # Returns a formatted string.
+# The string is produced according to the *format_string* with format specifiers
+# being replaced by values from *args* formatted according to the specifier.
 #
-# See also: `IO#printf`.
+# Within the format string, any characters other than format specifiers
+# (specifiers beginning with `%`) are copied to the result.
+#
+# The syntax for a format specifier is:
+#
+# ```text
+# %[flags][width][.precision]type
+# ```
+#
+# A format specifier consists of a percent sign, followed by optional flags,
+# width, and precision indicators, then terminated with a field type
+# character.
+#
+# The field type controls how the corresponding
+# `sprintf` argument is to be interpreted, while the flags
+# modify that interpretation.
+#
+# The field type characters are:
+#
+# ```text
+#     Field |  Integer Format
+#     ------+--------------------------------------------------------------
+#       b   | Formats argument as a binary number.
+#       d   | Formats argument as a decimal number.
+#       i   | Same as d.
+#       o   | Formats argument as an octal number.
+#       x   | Formats argument as a hexadecimal number using lowercase letters.
+#       X   | Same as x, but uses uppercase letters.
+#
+#     Field |  Float Format
+#     ------+--------------------------------------------------------------
+#       e   | Formats floating point argument into exponential notation
+#           | with one digit before the decimal point as [-]d.dddddde[+-]dd.
+#           | The precision specifies the number of digits after the decimal
+#           | point (defaulting to six).
+#       E   | Equivalent to e, but uses an uppercase E to indicate
+#           | the exponent.
+#       f   | Formats floating point argument as [-]ddd.dddddd,
+#           | where the precision specifies the number of digits after
+#           | the decimal point.
+#       g   | Formats a floating point number using exponential form
+#           | if the exponent is less than -4 or greater than or
+#           | equal to the precision, or in dd.dddd form otherwise.
+#           | The precision specifies the number of significant digits.
+#       G   | Equivalent to g, but use an uppercase E in exponent form.
+#       a   | Formats floating point argument as [-]0xh.hhhhp[+-]dd,
+#           | which is consisted from optional sign, "0x", fraction part
+#           | as hexadecimal, "p", and exponential part as decimal.
+#       A   | Equivalent to a, but use uppercase X and P.
+#
+#     Field |  Other Format
+#     ------+--------------------------------------------------------------
+#       c   | Argument is the numeric code for a single character or
+#           | a single character string itself.
+#       s   | Argument is a string to be substituted.  If the format
+#           | sequence contains a precision, at most that many characters
+#           | will be copied.
+#       %   | A percent sign itself will be displayed.  No argument taken.
+#
+# ```
+# The flags modifies the behavior of the formats.
+# The flag characters are:
+# ```text
+#
+#   Flag     | Applies to    | Meaning
+#   ---------+---------------+-----------------------------------------
+#   space    | bdiouxX       | Add a leading space character to
+#            | aAeEfgG       | non-negative numbers.
+#            | (numeric fmt) | For o, x, X, b, use
+#            |               | a minus sign with absolute value for
+#            |               | negative values.
+#   ---------+---------------+-----------------------------------------
+#   +        | bdiouxX       | Add a leading plus sign to non-negative
+#            | aAeEfgG       | numbers.
+#            | (numeric fmt) | For o, x, X, b, use
+#            |               | a minus sign with absolute value for
+#            |               | negative values.
+#   ---------+---------------+-----------------------------------------
+#   -        | all           | Left-justify the result of this conversion.
+#   ---------+---------------+-----------------------------------------
+#   0 (zero) | bdiouxX       | Pad with zeros, not spaces.
+#            | aAeEfgG       | For o, x, X, b, radix-1
+#            | (numeric fmt) | is used for negative numbers formatted as
+#            |               | complements.
+# ```
+#
+# Examples of flags:
+#
+# Decimal number conversion
+# ```
+# sprintf "%d", 123  # => "123"
+# sprintf "%+d", 123 # => "+123"
+# sprintf "% d", 123 # => " 123"
+# ```
+#
+# Octal number conversion
+# ```
+# sprintf "%o", 123   # => "173"
+# sprintf "%+o", 123  # => "+173"
+# sprintf "%o", -123  # => "-173"
+# sprintf "%+o", -123 # => "-173"
+# ```
+#
+# Hexadecimal number conversion
+# ```
+# sprintf "%x", 123   # => "7b"
+# sprintf "%+x", 123  # => "+7b"
+# sprintf "%x", -123  # => "-7b"
+# sprintf "%+x", -123 # => "-7b"
+# sprintf "%#x", 0    # => "0"
+# sprintf "% x", 123  # => " 7b"
+# sprintf "% x", -123 # => "-7b"
+# sprintf "%X", 123   # => "7B"
+# sprintf "%#X", -123 # => "-7B"
+# ```
+#
+# Binary number conversion
+# ```
+# sprintf "%b", 123    # => "1111011"
+# sprintf "%+b", 123   # => "+1111011"
+# sprintf "%+b", -123  # => "-1111011"
+# sprintf "%b", -123   # => "-1111011"
+# sprintf "%#b", 0     # => "0"
+# sprintf "% b", 123   # => " 1111011"
+# sprintf "%+ b", 123  # => "+ 1111011"
+# sprintf "% b", -123  # => "-1111011"
+# sprintf "%+ b", -123 # => "-1111011"
+# ```
+#
+# Floating point conversion
+# ```
+# sprintf "%a", 123 # => "0x1.ecp+6"
+# sprintf "%A", 123 # => "0X1.ECP+6"
+# ```
+#
+# Exponential form conversion
+# ```
+# sprintf "%g", 123.4          # => "123.4"
+# sprintf "%g", 123.4567       # => "123.457"
+# sprintf "%20.8g", 1234.56789 # => "           1234.5679"
+# sprintf "%20.8g", 123456789  # => "       1.2345679e+08"
+# sprintf "%20.8G", 123456789  # => "       1.2345679E+08"
+# sprintf "%20.8g", -123456789 # => "       -1.2345679e+08"
+# sprintf "%20.8G", -123456789 # => "       -1.2345679E+08"
+# ```
+#
+# The field width is an optional integer, followed optionally by a
+# period and a precision. The width specifies the minimum number of
+# characters that will be written to the result for this field.
+#
+# Examples of width:
+# ```
+# sprintf "%20d", 123   # => "                 123"
+# sprintf "%+20d", 123  # => "                +123"
+# sprintf "%020d", 123  # => "00000000000000000123"
+# sprintf "%+020d", 12  # => "+0000000000000000123"
+# sprintf "% 020d", 123 # => " 0000000000000000123"
+# sprintf "%-20d", 123  # => "123                 "
+# sprintf "%-+20d", 123 # => "+123                "
+# sprintf "%- 20d", 123 # => " 123                "
+# sprintf "%020x", -123 # => "00000000000000000-7b"
+# sprintf "%020X", -123 # => "00000000000000000-7B"
+# ```
+#
+# For numeric fields, the precision controls the number of decimal places
+# displayed.
+#
+# For string fields, the precision determines the maximum
+# number of characters to be copied from the string.
+#
+# Examples of precisions:
+#
+# Precision for `d`, `o`, `x` and `b` is
+# minimum number of digits
+# ```
+# sprintf "%20.8d", 123   # => "                 123"
+# sprintf "%020.8d", 123  # => "00000000000000000123"
+# sprintf "%20.8o", 123   # => "                 173"
+# sprintf "%020.8o", 123  # => "00000000000000000173"
+# sprintf "%20.8x", 123   # => "                  7b"
+# sprintf "%020.8x", 123  # => "0000000000000000007b"
+# sprintf "%20.8b", 123   # => "            01111011"
+# sprintf "%20.8d", -123  # => "                -123"
+# sprintf "%020.8d", -123 # => "0000000000000000-123"
+# sprintf "%20.8o", -123  # => "                -173"
+# sprintf "%20.8x", -123  # => "                 -7b"
+# sprintf "%20.8b", -11   # => "               -1011"
+# ```
+#
+# Precision for `e` is number of digits after the decimal point.
+# ```
+# sprintf "%20.8e", 1234.56789 # => "      1.23456789e+03"
+# ```
+#
+# Precision for `f` is number of digits after the decimal point.
+# ```
+# sprintf "%20.8f", 1234.56789 # => "       1234.56789000"
+# ```
+#
+# Precision for `g` is number of significant digits.
+# ```
+# sprintf "%20.8g", 1234.56789 # => "           1234.5679"
+# sprintf "%20.8g", 123456789  # => "       1.2345679e+08"
+# sprintf "%-20.8g", 123456789 # => "1.2345679e+08       "
+# ```
+#
+# Precision for `s` is maximum number of characters.
+# ```
+# sprintf "%20.8s", "string test" # => "            string t"
+# ```
+#
+# Additional examples:
+# ```
+# sprintf "%d %04x", 123, 123             # => "123 007b"
+# sprintf "%08b '%4s'", 123, 123          # => "01111011 ' 123'"
+# sprintf "%+g:% g:%-g", 1.23, 1.23, 1.23 # => "+1.23: 1.23:1.23"
+# ```
 def sprintf(format_string, *args) : String
   sprintf format_string, args
 end