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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
