[Docs] Link to Go documentation references outdated documentation from 2018 #39761
Comments
gtomitsuka
changed the title
kou
pushed a commit
that referenced
this issue
Jan 24, 2024
…tation from 2018 (#39750) ### Rationale for this change The godoc format shows docs in a versioned fashion, making the ["basic" link](https://pkg.go.dev/github.com/apache/arrow/go) reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs. Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong. ### What changes are included in this PR? * Reference the latest version (v16) in the list of supported implementations of the Arrow website & R package. * Add step to release process that automatically updates the version on release ### Are these changes tested? Yes, I've added tests for this to `dev/release/post-11-bump-versions-test.rb`. ### Are there any user-facing changes? Yes, the link to Implementations > Go on the website will change. * Closes: #39761 Authored-by: Gabriel Tomitsuka <g@gtomitsuka.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
dgreiss
pushed a commit
to dgreiss/arrow
that referenced
this issue
Feb 19, 2024
…ocumentation from 2018 (apache#39750) ### Rationale for this change The godoc format shows docs in a versioned fashion, making the ["basic" link](https://pkg.go.dev/github.com/apache/arrow/go) reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs. Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong. ### What changes are included in this PR? * Reference the latest version (v16) in the list of supported implementations of the Arrow website & R package. * Add step to release process that automatically updates the version on release ### Are these changes tested? Yes, I've added tests for this to `dev/release/post-11-bump-versions-test.rb`. ### Are there any user-facing changes? Yes, the link to Implementations > Go on the website will change. * Closes: apache#39761 Authored-by: Gabriel Tomitsuka <g@gtomitsuka.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
zanmato1984
pushed a commit
to zanmato1984/arrow
that referenced
this issue
Feb 28, 2024
…ocumentation from 2018 (apache#39750) ### Rationale for this change The godoc format shows docs in a versioned fashion, making the ["basic" link](https://pkg.go.dev/github.com/apache/arrow/go) reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs. Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong. ### What changes are included in this PR? * Reference the latest version (v16) in the list of supported implementations of the Arrow website & R package. * Add step to release process that automatically updates the version on release ### Are these changes tested? Yes, I've added tests for this to `dev/release/post-11-bump-versions-test.rb`. ### Are there any user-facing changes? Yes, the link to Implementations > Go on the website will change. * Closes: apache#39761 Authored-by: Gabriel Tomitsuka <g@gtomitsuka.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
thisisnic
pushed a commit
that referenced
this issue
Mar 8, 2024
…tation from 2018 (#39750) ### Rationale for this change The godoc format shows docs in a versioned fashion, making the ["basic" link](https://pkg.go.dev/github.com/apache/arrow/go) reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs. Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong. ### What changes are included in this PR? * Reference the latest version (v16) in the list of supported implementations of the Arrow website & R package. * Add step to release process that automatically updates the version on release ### Are these changes tested? Yes, I've added tests for this to `dev/release/post-11-bump-versions-test.rb`. ### Are there any user-facing changes? Yes, the link to Implementations > Go on the website will change. * Closes: #39761 Authored-by: Gabriel Tomitsuka <g@gtomitsuka.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
thisisnic
pushed a commit
to thisisnic/arrow
that referenced
this issue
Mar 8, 2024
…ocumentation from 2018 (apache#39750) ### Rationale for this change The godoc format shows docs in a versioned fashion, making the ["basic" link](https://pkg.go.dev/github.com/apache/arrow/go) reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs. Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong. ### What changes are included in this PR? * Reference the latest version (v16) in the list of supported implementations of the Arrow website & R package. * Add step to release process that automatically updates the version on release ### Are these changes tested? Yes, I've added tests for this to `dev/release/post-11-bump-versions-test.rb`. ### Are there any user-facing changes? Yes, the link to Implementations > Go on the website will change. * Closes: apache#39761 Authored-by: Gabriel Tomitsuka <g@gtomitsuka.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the enhancement requested
The godoc format shows docs in a versioned fashion, making the "basic" link reference v0.0.0 from 2018, and godoc doesn't warn you when docs are outdated. Accordingly, for people to find "real" documentation, they have to manually search for the latest docs.
Otherwise, it gives the impression that the package is abandoned / makes devs waste considerable time — e.g., I work with Go professionally and wasted 15 minutes on the 2018 docs until I realized they were wrong.
I have a PR for this (#39750), which is currently tagged as MINOR, but can't as this change will require tweaks to the release process. I'm creating this issue so I can update the
.shscript in that PR and move it from a MINOR to regular PR.Component(s)
Documentation
The text was updated successfully, but these errors were encountered: