improve @(s)printf docstrings (JuliaLang#47583)

ArnoStrouwen · Nov 29, 2022 · 4d5fd91 · 4d5fd91
1 parent 4fd26ba
commit 4d5fd91
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/stdlib/Printf/src/Printf.jl b/stdlib/Printf/src/Printf.jl
@@ -911,6 +911,10 @@ Use shorter of decimal or scientific 1.23 1.23e+07
 For a systematic specification of the format, see [here](https://www.cplusplus.com/reference/cstdio/printf/).
 See also [`@sprintf`](@ref) to get the result as a `String` instead of it being printed.
 
+If you need to use a programmatically generated format string, use
+`print(Printf.format(Printf.Format(format_string), args...))` instead.
+See [`Printf.format`](@ref) for more details.
+
 # Caveats
 `Inf` and `NaN` are printed consistently as `Inf` and `NaN` for flags `%a`, `%A`,
 `%e`, `%E`, `%f`, `%F`, `%g`, and `%G`. Furthermore, if a floating point number is
@@ -951,6 +955,10 @@ end
 
 Return [`@printf`](@ref) formatted output as string.
 
+If you need to use a programmatically generated format string, use
+`Printf.format(Printf.Format(format_string), args...)` instead.
+See [`Printf.format`](@ref) for more details.
+
 # Examples
 ```jldoctest
 julia> @sprintf "this is a %s %15.1f" "test" 34.567