You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "gtomitsuka (via GitHub)" <gi...@apache.org> on 2024/01/22 19:42:23 UTC
[PR] MINOR: [DOCS] Link to Go documentation references outdated documentation from 2018 [arrow]
gtomitsuka opened a new pull request, #39750:
URL: https://github.com/apache/arrow/pull/39750
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
to contribute here:
* [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
* [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
In the case of PARQUET issues on JIRA the title also supports:
PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
-->
### 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 v15 docs. Otherwise, it gives the impression that the package is abandoned.
### What changes are included in this PR?
Reference the latest version (v15) in the list of supported implementations of the Arrow docs.
### Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
No, doc-only.
### Are there any user-facing changes?
No.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "gtomitsuka (via GitHub)" <gi...@apache.org>.
gtomitsuka commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1905888364
Should be fixed now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1905850574
:warning: GitHub issue #39761 **has been automatically assigned in GitHub** to PR creator.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "gtomitsuka (via GitHub)" <gi...@apache.org>.
gtomitsuka commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1904902892
I've researched this and haven't found any way to tag a version as latest on godoc; it seems that the team is already aware of this issue and uses the static link to `arrow/v16` on [arrow/go/README.md](https://github.com/apache/arrow/blob/main/go/README.md?plain=1#L23), I wasn't sure which version to use as only v15 is tagged but happy to switch to v16
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1908514457
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 2e8bd8d0b53560a561656337021abc3e4aa73f8c.
There were no benchmark performance regressions. 🎉
The [full Conbench report](https://github.com/apache/arrow/runs/20825314043) has more details.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1905072624
We substitute it in our release process: https://github.com/apache/arrow/blob/c9ca62ad781f1dd999570a51cae6d7c464af6e5c/dev/release/utils-prepare.sh#L152-L165
If we need it, could you open a new issue (this is not a MINOR fix https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes ) and use the same approach in this PR?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou merged PR #39750:
URL: https://github.com/apache/arrow/pull/39750
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #39750:
URL: https://github.com/apache/arrow/pull/39750#discussion_r1464031189
##########
dev/release/utils-prepare.sh:
##########
@@ -139,6 +140,12 @@ update_versions() {
fi
rm -f NEWS.md.bak
git add NEWS.md
+
+ find . -name "_pkgdown.yml" -exec sed -i.bak -E -e \
+ "s|(github\\.com/apache/arrow/go)/v[0-9]+|\1/v${major_version}|g" {} \;
Review Comment:
We don't need to use `find` here:
```suggestion
sed -i.bak -E -e \
"s|(github\\.com/apache/arrow/go)/v[0-9]+|\1/v${major_version}|g" \
_pkgdown.yml
```
##########
dev/release/utils-prepare.sh:
##########
@@ -164,6 +171,15 @@ update_versions() {
git add .
popd
+ pushd "${ARROW_DIR}/docs/source"
+ # godoc link must reference current version, will reference v0.0.0 (2018) otherwise
+ find . -name "index.rst" -exec sed -i.bak -E -e \
+ "s|(github\\.com/apache/arrow/go)/v[0-9]+|\1/v${major_version}|g" {} \;
+
+ rm -f index.rst.bak
Review Comment:
ditto.
##########
dev/release/utils-prepare.sh:
##########
@@ -164,6 +171,15 @@ update_versions() {
git add .
popd
+ pushd "${ARROW_DIR}/docs/source"
+ # godoc link must reference current version, will reference v0.0.0 (2018) otherwise
Review Comment:
Could you add this comment to the `r/_pkgdown.yml` part too?
##########
dev/release/utils-prepare.sh:
##########
@@ -139,6 +140,12 @@ update_versions() {
fi
rm -f NEWS.md.bak
git add NEWS.md
+
+ find . -name "_pkgdown.yml" -exec sed -i.bak -E -e \
+ "s|(github\\.com/apache/arrow/go)/v[0-9]+|\1/v${major_version}|g" {} \;
+
Review Comment:
Could you remove this empty line because the above `sed` and this `rm` are related?
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #39750:
URL: https://github.com/apache/arrow/pull/39750#discussion_r1464136272
##########
dev/release/post-11-bump-versions-test.rb:
##########
@@ -197,6 +197,13 @@ def test_version_post_tag
]
if release_type == :major
expected_changes += [
+ {
+ path: "docs/source/index.rst",
+ hunks: [
+ "- Go <https://pkg.go.dev/github.com/apache/arrow/go/v#{@snapshot_major_version}>",
+ "+ Go <https://pkg.go.dev/github.com/apache/arrow/go/v#{@next_major_version}>",
+ ],
Review Comment:
```suggestion
hunks: [
[
"- Go <https://pkg.go.dev/github.com/apache/arrow/go/v#{@snapshot_major_version}>",
"+ Go <https://pkg.go.dev/github.com/apache/arrow/go/v#{@next_major_version}>",
],
],
```
##########
dev/release/post-11-bump-versions-test.rb:
##########
@@ -212,6 +219,13 @@ def test_version_post_tag
],
],
},
+ {
+ path: "r/_pkgdown.yml",
+ hunks: [
+ "- [Go](https://pkg.go.dev/github.com/apache/arrow/go/v#{@snapshot_major_version}) <br>",
+ "+ [Go](https://pkg.go.dev/github.com/apache/arrow/go/v#{@next_major_version}) <br>",
+ ],
Review Comment:
```suggestion
hunks: [
[
"- [Go](https://pkg.go.dev/github.com/apache/arrow/go/v#{@snapshot_major_version}) <br>",
"+ [Go](https://pkg.go.dev/github.com/apache/arrow/go/v#{@next_major_version}) <br>",
],
],
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1904879718
If we specify a version statically, we need to update it periodically.
Can we use a URL that refers the latest version?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-39761: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "gtomitsuka (via GitHub)" <gi...@apache.org>.
gtomitsuka commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1906869578
Thanks for pointing me in the right direction! I updated `dev/release/post-11-bump-versions-test.rb`, the tests should pass now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: [Docs] Link to Go documentation references outdated documentation from 2018 [arrow]
Posted by "gtomitsuka (via GitHub)" <gi...@apache.org>.
gtomitsuka commented on PR #39750:
URL: https://github.com/apache/arrow/pull/39750#issuecomment-1905840089
Yep, will do
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org