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.

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

Go documentation needs versioning (especially language spec) #68

Closed
gopherbot opened this issue Nov 11, 2009 · 5 comments
Closed

Go documentation needs versioning (especially language spec) #68

gopherbot opened this issue Nov 11, 2009 · 5 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge

Comments

@gopherbot
Copy link
Contributor

by autophile:

I'm playing around with creating a Netbeans module for Go language support. As such, I'm
using 
the language spec from here: http://golang.org/doc/go_spec.html

Unfortunately, this document has no version number, so I would not be able to indicate
in my 
module what version of the Go language is supported, nor would I be able to determine if
the 
language spec changed.

Please version the documentation!
@rsc
Copy link
Contributor

rsc commented Nov 11, 2009

Comment 1:

Thanks, good suggestion.  As a workaround for now you can use
the date of the spec.  The revision control tools we are using will
let you see what has changed since a given date.

Status changed to Accepted.

@gopherbot
Copy link
Contributor Author

Comment 2 by debrabander:

Not just a document version number is desirable, but also detailed "ChangeLog" on the
golang.org website of any modifications made to the Go language. If you upgrade the
toolchain, you'll notice these language modifications the hard way by compilation
errors. Or you'll have to use the revision tools for diffs and commit messages on the
source code and documentation...

@rsc
Copy link
Contributor

rsc commented Nov 15, 2009

Comment 3:

I thought more about this, and using the revision tools doesn't seem
like such a terrible thing.  That's what they're for.
I think we should add a date to the spec, but the revision control
system is a perfectly good versioning system and authoritative 
record of what changed.
Assigning to gri for adding of the date or other consideration.

Owner changed to [email protected].

@rsc
Copy link
Contributor

rsc commented Dec 2, 2009

Comment 4:

Labels changed: added documentation.

@griesemer
Copy link
Contributor

Comment 5:

This issue was closed by revision e8e4987.

Status changed to Fixed.

@gopherbot gopherbot added fixed Documentation Issues describing a change to documentation. labels Mar 31, 2010
minux pushed a commit to minux/goios that referenced this issue Feb 27, 2015
@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.
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge
Projects
None yet
Development

No branches or pull requests

3 participants