go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-05 03:17:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document the use of slurp with printf

Browse Source 
A recent IM question, and subsequent discussion, resulted in @hhanche
commenting that if you need to explicitly move the output of `printf`
from the byte to the value stream you should use `slurp` rather than
`put` or `from-lines`. Include that insight in the `printf`
documentation.
This commit is contained in:
Kurtis Rader 2021-11-09 20:22:39 -08:00 committed by Qi Xiao
parent 8faf8930b3
commit c59e01abfc
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/eval/builtin_fn_io.go
View File

@ -221,10 +221,13 @@ func print(fm *Frame, opts printOpts, args ...interface{}) error {
// printf $template $value...
// ```
//
// Prints values to the byte stream according to a template.
// Prints values to the byte stream according to a template. If you need to inject the output into
// the value stream use this pattern: `printf .... | slurp`. That ensures that any newlines in the
// output of `printf` do not cause its output to be broken into multiple values, thus eliminating
// the newlines, which will occur if you do `put (printf ....)`.
//
// Like [`print`](#print), this command does not add an implicit newline; use
// an explicit `"\n"` in the formatting template instead.
// Like [`print`](#print), this command does not add an implicit newline; include an explicit `"\n"`
// in the formatting template instead. For example, `printf "%.1f\n" (/ 10.0 3)`.
//
// See Go's [`fmt`](https://golang.org/pkg/fmt/#hdr-Printing) package for
// details about the formatting verbs and the various flags that modify the