aboutsummaryrefslogtreecommitdiffstats
path: root/plumbing/format/pktline/encoder.go
diff options
context:
space:
mode:
authorAntonio Jesus Navarro Perez <antonio@sourced.tech>2017-02-23 17:07:08 +0100
committerAntonio Jesus Navarro Perez <antonio@sourced.tech>2017-02-23 17:14:43 +0100
commit059a0be78399cdb0648bd514c5b179819d84403d (patch)
tree007fea2e8529b865b354b45c8aed9045e136d462 /plumbing/format/pktline/encoder.go
parentb5da4e98571b02dc106de4f9b2cb2a298489f1b1 (diff)
downloadgo-git-059a0be78399cdb0648bd514c5b179819d84403d.tar.gz
plumbing: improve documentation (Fix #242)
Diffstat (limited to 'plumbing/format/pktline/encoder.go')
-rw-r--r--plumbing/format/pktline/encoder.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/plumbing/format/pktline/encoder.go b/plumbing/format/pktline/encoder.go
index 753b225..797b813 100644
--- a/plumbing/format/pktline/encoder.go
+++ b/plumbing/format/pktline/encoder.go
@@ -116,7 +116,8 @@ func (e *Encoder) EncodeString(payloads ...string) error {
}
// Encodef encodes a single pkt-line with the payload formatted as
-// the format specifier and the rest of the arguments suggest.
+// the format specifier. The rest of the arguments will be used in
+// the format string.
func (e *Encoder) Encodef(format string, a ...interface{}) error {
return e.EncodeString(
fmt.Sprintf(format, a...),