Merge pull request #138 from ipfs/misc/query-string-comment

Stebalien · web-flow · commit 146d37558a54 · 2019-11-11T16:38:40.000+01:00
Add clarifying comments on Query#String()
diff --git a/query/query.go b/query/query.go
@@ -68,6 +68,8 @@ type Query struct {
 	ReturnExpirations bool     // return expirations (see TTLDatastore)
 }
 
+// String returns a string represenation of the Query for debugging/validation
+// purposes. Do not use it for SQL queries.
 func (q Query) String() string {
 	s := "SELECT keys"
 	if !q.KeysOnly {

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,8 @@ type Query struct {`
`68`	`68`	`ReturnExpirations bool // return expirations (see TTLDatastore)`
`69`	`69`	`}`
`70`	`70`
	`71`	`+// String returns a string represenation of the Query for debugging/validation`
	`72`	`+// purposes. Do not use it for SQL queries.`
`71`	`73`	`func (q Query) String() string {`
`72`	`74`	`s := "SELECT keys"`
`73`	`75`	`if !q.KeysOnly {`