aboutsummaryrefslogtreecommitdiff
path: root/src/database/sql/sql.go
diff options
context:
space:
mode:
authorBrad Fitzpatrick <bradfitz@golang.org>2016-12-09 19:58:11 +0000
committerBrad Fitzpatrick <bradfitz@golang.org>2016-12-09 20:19:06 +0000
commit454c2343979b8976f3f1ac50f8149b36a839d555 (patch)
tree7fe283198658d5cea7c290645ee2c14c7dcf5242 /src/database/sql/sql.go
parentc586630d993f6136d3166837669b26f4210a79d5 (diff)
downloadgo-454c2343979b8976f3f1ac50f8149b36a839d555.tar.xz
database/sql: use complete sentences in new docs
Change-Id: Icb842a80cab2b07b9ace1e8e14c4a19c48a92c43 Reviewed-on: https://go-review.googlesource.com/34247 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: Daniel Theophanes <kardianos@gmail.com>
Diffstat (limited to 'src/database/sql/sql.go')
-rw-r--r--src/database/sql/sql.go19
1 files changed, 13 insertions, 6 deletions
diff --git a/src/database/sql/sql.go b/src/database/sql/sql.go
index 1cc1687604..9f056c51e2 100644
--- a/src/database/sql/sql.go
+++ b/src/database/sql/sql.go
@@ -72,19 +72,26 @@ func Drivers() []string {
return list
}
-// A NamedArg used as an argument to Query or Exec
-// binds to the corresponding named parameter in the SQL statement.
+// A NamedArg is a named argument. NamedArg values may be used as
+// arguments to Query or Exec and bind to the corresponding named
+// parameter in the SQL statement.
+//
+// For a more concise way to create NamedArg values, see
+// the Named function.
type NamedArg struct {
_Named_Fields_Required struct{}
- // Name of the parameter placeholder. If empty the ordinal position in the
- // argument list will be used.
+ // Name is the name of the parameter placeholder.
+ //
+ // If empty, the ordinal position in the argument list will be
+ // used.
//
// Name must omit any symbol prefix.
Name string
- // Value of the parameter. It may be assigned the same value types as
- // the query arguments.
+ // Value is the value of the parameter.
+ // It may be assigned the same value types as the query
+ // arguments.
Value interface{}
}