sync/atomic: improve package docs #18955
Labels
Documentation
Issues describing a change to documentation.
FrozenDueToAge
help wanted
NeedsFix
The path to resolution is known, but the work has not been done.
Milestone
At the end of the API docs of sync/atomic, https://golang.org/pkg/sync/atomic/, it says:
It could be improved as
The reason is there are many local variables and arrays which addresses are passed as the parameters atomic 64bit functions, in go project source.
And "the first word in an allocated slice" is not an accurate description, it should be the first element in an allocated slice which elements are 64-bit words.
And the expvar package docs should warning that expvar.Int and expvar.Float are not safe to be embedded in other types on 32bit OSes.
Please see this thread for detail: https://groups.google.com/forum/#!topic/golang-nuts/_nHK6P8_lhw
The text was updated successfully, but these errors were encountered: