Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

database/sql: improve package documentation #5886

Closed
adg opened this issue Jul 15, 2013 · 16 comments
Closed

database/sql: improve package documentation #5886

adg opened this issue Jul 15, 2013 · 16 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge
Milestone
Go1.3

Comments

@adg
Copy link
Contributor

adg commented Jul 15, 2013 

The database/sql package docs say:

"Package sql provides a generic interface around SQL (or SQL-like) databases. The
sql package must be used in conjunction with a database driver. See
http://golang.org/s/sqldrivers for a list of drivers."

And the sqldrivers wiki page is not very illuminating.

Users should be able to read the package docs and come away knowing everything they need
to connect their Go program to their database.
@adg
Copy link
Contributor Author

adg commented Jul 15, 2013

Comment 1:

Labels changed: added priority-soon, go1.2, removed acc.

@rsc
Copy link
Contributor

rsc commented Sep 10, 2013

Comment 2:

Labels changed: added documentation.

@rsc
Copy link
Contributor

rsc commented Sep 11, 2013

Comment 3:

Labels changed: added go1.2maybe, removed go1.2.

@mattrco
Copy link

mattrco commented Sep 17, 2013

Comment 4:

I can take this on if nobody else is currently working on it.
I plan to extend the docs with an overview (using
http://golang.org/src/pkg/database/sql/doc.txt as a reference), example connections,
more example queries, and how to handle returned data/errors.

@mattrco
Copy link

mattrco commented Sep 23, 2013

Comment 5:

As a first step I propose renaming http://golang.org/src/pkg/database/sql/doc.txt to
doc.go and formatting/extending it so that it can serve as package documentation.
Is this a good way to proceed or should that file be kept as-is?

@mattrco
Copy link

mattrco commented Sep 28, 2013

Comment 6:

https://golang.org/cl/14087043
PTAL.

@rsc
Copy link
Contributor

rsc commented Oct 3, 2013

Comment 7:

We're going to postpone major revisions until after the release. We're too close to
cutting a release candidate.

Labels changed: added go1.3, removed go1.2maybe.

@bradfitz
Copy link
Contributor

Comment 8:

This issue was updated by revision 17a03d8.

R=golang-dev, kamil.kisiel, adg, r, rsc, dave, arnehormann, bradfitz
CC=golang-dev
https://golang.org/cl/14087043
Committer: Brad Fitzpatrick

@adg
Copy link
Contributor Author

adg commented Nov 1, 2013

Comment 9:

This issue was updated by revision 220dfbb528c6.
R=golang-dev, kamil.kisiel, adg, r, rsc, dave, arnehormann, bradfitz
CC=golang-dev
https://golang.org/cl/14087043
Committer: Brad Fitzpatrick <bradfitz@golang.org>
»»»
R=golang-dev
CC=golang-dev
https://golang.org/cl/20610043

@rsc
Copy link
Contributor

rsc commented Dec 4, 2013

Comment 10:

Labels changed: added release-go1.3.

@rsc
Copy link
Contributor

rsc commented Dec 4, 2013

Comment 11:

Labels changed: removed go1.3.

@rsc
Copy link
Contributor

rsc commented Dec 4, 2013

Comment 12:

Labels changed: added repo-main.

@mattrco
Copy link

mattrco commented Dec 17, 2013

Comment 13:

As discussed[1], another CL will be incoming with executable examples.
There's still the question of whether the link to the wiki page and more examples is
sufficient to close this issue.
[1]https://golang.org/cl/14087043

@mattrco
Copy link

mattrco commented Dec 21, 2013

Comment 14:

https://golang.org/cl/44920043

@gopherbot
Copy link
Contributor

Comment 15:

CL https://golang.org/cl/100560043 mentions this issue.

@bradfitz
Copy link
Contributor

Comment 16:

This issue was closed by revision 7b103c5.

Status changed to Fixed.

@adg adg added fixed Documentation Issues describing a change to documentation. labels May 19, 2014
@rsc rsc added this to the Go1.3 milestone Apr 14, 2015
@rsc rsc removed the release-go1.3 label Apr 14, 2015
adg added a commit that referenced this issue May 11, 2015
@adg @bradfitz
[release-branch.go1.2] database/sql: link to wiki in package docs
7191e08 
««« CL 14087043 / 7ebbddd21330
database/sql: link to wiki in package docs

Update #5886

R=golang-dev, kamil.kisiel, adg, r, rsc, dave, arnehormann, bradfitz
CC=golang-dev
https://golang.org/cl/14087043

»»»

R=golang-dev
CC=golang-dev
https://golang.org/cl/20610043
@golang golang locked and limited conversation to collaborators Jun 24, 2016
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge
Projects
None yet
Milestone
Go1.3
Development

No branches or pull requests
5 participants
@bradfitz @rsc @mattrco @adg @gopherbot