You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When browsing Go packages, it is impossible to know since when a type or a function is part of the language. In fact, off the top of my head, I don't know any feasible way to get this information, apart from:
git blameing the specified source (which won't work if there were styling adjustments / documentation updates)
using that function/type and running a build across all Go versions and check when the build starts failing.
browsing all Go release patch notes looking for the function/type in question.
All of these steps are very cumbersome.
A way to identify the version since when a package feature is available would be very handy, especially for projects that try to support multiple Go versions. In general, it would be very informative to browse a package and see when a feature was introduced, and enable the reader to load up the release notes of that version and see if they can find some motivation behind the feature. It could also be the last straw to make the reader finally upgrade to the latest version.
For example, Java does this and it truly has its benefits.
While the PROs are very strong, the CON obviously is that it is a lot of work to update the docs to include this information.
The text was updated successfully, but these errors were encountered:
muja
changed the title
proposal: Documentation for Go packages should have 'since GOVERSION' at the end
proposal: Documentation for Go package types and functions should have 'since GOVERSION' at the end
Jan 6, 2018
For the standard library, this is a duplicate of #5778.
For third party packages, a proposal needs to include a decent way to obtain the information necessary. Depending on git or running multiple builds both seem like bad approaches.
When browsing Go packages, it is impossible to know since when a type or a function is part of the language. In fact, off the top of my head, I don't know any feasible way to get this information, apart from:
git blame
ing the specified source (which won't work if there were styling adjustments / documentation updates)All of these steps are very cumbersome.
A way to identify the version since when a package feature is available would be very handy, especially for projects that try to support multiple Go versions. In general, it would be very informative to browse a package and see when a feature was introduced, and enable the reader to load up the release notes of that version and see if they can find some motivation behind the feature. It could also be the last straw to make the reader finally upgrade to the latest version.
For example, Java does this and it truly has its benefits.
While the PROs are very strong, the CON obviously is that it is a lot of work to update the docs to include this information.
The text was updated successfully, but these errors were encountered: