You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2023/04/18 12:24:34 UTC
[GitHub] [arrow-datafusion] alamb opened a new pull request, #6044: Clean up rustdoc and add doc lint
alamb opened a new pull request, #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044
# Which issue does this PR close?
Closes https://github.com/apache/arrow-datafusion/issues/6042
# Rationale for this change
I am trying to get the rustdoc API docs into better shape.
# What changes are included in this PR?
1. Fix `cargo doc`
2. Add new gitub workflow action to check that docs build is clean
# Are these changes tested?
Yes -- new lint
# Are there any user-facing changes?
Some broken links in API docs are fixed
--
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
[GitHub] [arrow-datafusion] waynexia commented on a diff in pull request #6044: Clean up rustdoc and add doc lint
Posted by "waynexia (via GitHub)" <gi...@apache.org>.
waynexia commented on code in PR #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044#discussion_r1172047349
##########
.github/workflows/rust.yml:
##########
@@ -157,6 +157,24 @@ jobs:
- name: Verify Working Directory Clean
run: git diff --exit-code
+ # Run `cargo doc` to ensure the rustdoc is clean
+ linux-rustdoc:
+ name: cargo doc
+ needs: [ linux-build-lib ]
+ runs-on: ubuntu-latest
+ container:
+ image: amd64/rust
+ steps:
+ - uses: actions/checkout@v3
+ - name: Setup Rust toolchain
+ uses: ./.github/actions/setup-builder
+ with:
+ rust-version: stable
+ - name: Run cargo doc
+ run: |
+ export RUSTDOCFLAGS="-D warnings -A rustdoc::private-intra-doc-links"
Review Comment:
👍
##########
datafusion/core/src/scheduler/task.rs:
##########
@@ -128,7 +128,7 @@ impl Task {
}
}
- /// Call [`Pipeline::poll_partition`], attempting to make progress on query execution
+ /// Call `Pipeline::poll_partition`, attempting to make progress on query execution
Review Comment:
It can be manually referenced. But I'm not sure whether `super` is suitable in this case
```suggestion
/// Call [`Pipeline::poll_partition`][super::pipeline::Pipeline::poll_partition],
/// attempting to make progress on query execution
```
##########
datafusion/core/src/physical_plan/planner.rs:
##########
@@ -1293,15 +1293,15 @@ impl DefaultPhysicalPlanner {
}
/// Expand and align a GROUPING SET expression.
Review Comment:
nit (but isn't introduced in this PR):
```suggestion
/// Expand and align a GROUPING SET expression.
```
--
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
[GitHub] [arrow-datafusion] alamb merged pull request #6044: Clean up rustdoc and add doc lint
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044
--
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
[GitHub] [arrow-datafusion] alamb commented on pull request #6044: Clean up rustdoc and add doc lint
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044#issuecomment-1516115337
Thank you for the review @waynexia !
--
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
[GitHub] [arrow-datafusion] waynexia commented on pull request #6044: Clean up rustdoc and add doc lint
Posted by "waynexia (via GitHub)" <gi...@apache.org>.
waynexia commented on PR #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044#issuecomment-1514223123
Great work 🚀 This is also very helpful for https://github.com/apache/arrow-datafusion/issues/5981
--
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
[GitHub] [arrow-datafusion] alamb commented on a diff in pull request #6044: Clean up rustdoc and add doc lint
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044#discussion_r1172412239
##########
datafusion/core/src/scheduler/task.rs:
##########
@@ -128,7 +128,7 @@ impl Task {
}
}
- /// Call [`Pipeline::poll_partition`], attempting to make progress on query execution
+ /// Call `Pipeline::poll_partition`, attempting to make progress on query execution
Review Comment:
I'll give it a try and see how it goes
--
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
[GitHub] [arrow-datafusion] alamb commented on pull request #6044: Clean up rustdoc and add doc lint
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #6044:
URL: https://github.com/apache/arrow-datafusion/pull/6044#issuecomment-1514531259
Thank @waynexia -- hopefully I'll have this PR ready to go shortly
--
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