Skip to content

Commit 6e3154b

Browse files
killzonerkillzoner
authored
document private items and update docs CI (#1327)
* document private items and update docs CI * update checkout to v5
1 parent 0d2ac9a commit 6e3154b

File tree

15 files changed

+86
-37
lines changed

15 files changed

+86
-37
lines changed

‎.github/workflows/build.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
- "3.12"
4141
- "3.13"
4242
steps:
43-
- uses: actions/checkout@v4
43+
- uses: actions/checkout@v5
4444

4545
- uses: actions/setup-python@v5
4646
with:
@@ -67,7 +67,7 @@ jobs:
6767
build:
6868
runs-on: ubuntu-latest
6969
steps:
70-
- uses: actions/checkout@v4
70+
- uses: actions/checkout@v5
7171
- name: Install Python
7272
uses: actions/setup-python@v5
7373
with:
@@ -94,7 +94,7 @@ jobs:
9494
generate-license:
9595
runs-on: ubuntu-latest
9696
steps:
97-
- uses: actions/checkout@v4
97+
- uses: actions/checkout@v5
9898
- uses: astral-sh/setup-uv@v6
9999
with:
100100
enable-cache: true
@@ -115,7 +115,7 @@ jobs:
115115
python-version: ["3.10"]
116116
os: [macos-latest, windows-latest]
117117
steps:
118-
- uses: actions/checkout@v4
118+
- uses: actions/checkout@v5
119119

120120
- uses: actions/setup-python@v5
121121
with:
@@ -172,7 +172,7 @@ jobs:
172172
matrix:
173173
python-version: ["3.10"]
174174
steps:
175-
- uses: actions/checkout@v4
175+
- uses: actions/checkout@v5
176176

177177
- uses: actions/setup-python@v5
178178
with:
@@ -217,7 +217,7 @@ jobs:
217217
name: Manylinux x86_64
218218
runs-on: ubuntu-latest
219219
steps:
220-
- uses: actions/checkout@v4
220+
- uses: actions/checkout@v5
221221

222222
- uses: dtolnay/rust-toolchain@stable
223223

@@ -257,7 +257,7 @@ jobs:
257257
name: Manylinux arm64
258258
runs-on: ubuntu-latest
259259
steps:
260-
- uses: actions/checkout@v4
260+
- uses: actions/checkout@v5
261261

262262
- uses: dtolnay/rust-toolchain@stable
263263

@@ -297,7 +297,7 @@ jobs:
297297
name: Source distribution
298298
runs-on: ubuntu-latest
299299
steps:
300-
- uses: actions/checkout@v4
300+
- uses: actions/checkout@v5
301301

302302
- uses: dtolnay/rust-toolchain@stable
303303

‎.github/workflows/dev.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
runs-on: ubuntu-latest
2929
steps:
3030
- name: Checkout
31-
uses: actions/checkout@v4
31+
uses: actions/checkout@v5
3232
- name: Setup Python
3333
uses: actions/setup-python@v4
3434
with:

‎.github/workflows/dev_pr.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
name: Process
3434
runs-on: ubuntu-latest
3535
steps:
36-
- uses: actions/checkout@v4
36+
- uses: actions/checkout@v5
3737

3838
- name: Assign GitHub labels
3939
if: |

‎.github/workflows/docker.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
runs-on: ubuntu-latest
2929
steps:
3030
- name: Checkout
31-
uses: actions/checkout@v4
31+
uses: actions/checkout@v5
3232
- name: Installs Rust and Cargo
3333
run: curl -y --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
3434
- name: Run script

‎.github/workflows/docs.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ jobs:
3232
runs-on: ubuntu-latest
3333
steps:
3434
- name: Checkout docs sources
35-
uses: actions/checkout@v4
35+
uses: actions/checkout@v5
3636

3737
- name: Checkout asf-site branch
38-
uses: actions/checkout@v4
38+
uses: actions/checkout@v5
3939
with:
4040
ref: asf-site
4141
path: asf-site

‎.github/workflows/rust.yml‎

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ jobs:
4646
container:
4747
image: amd64/rust
4848
steps:
49-
- uses: actions/checkout@v4
49+
- uses: actions/checkout@v5
5050
with:
5151
submodules: true
52+
fetch-depth: 1
5253
- name: Setup Rust toolchain
5354
uses: ./.github/actions/setup-builder
5455
- name: Prepare cargo build
@@ -64,9 +65,10 @@ jobs:
6465
container:
6566
image: amd64/rust
6667
steps:
67-
- uses: actions/checkout@v4
68+
- uses: actions/checkout@v5
6869
with:
6970
submodules: true
71+
fetch-depth: 1
7072
- name: Setup Rust toolchain
7173
uses: ./.github/actions/setup-builder
7274
- name: Run tests
@@ -79,15 +81,32 @@ jobs:
7981
CARGO_HOME: "/github/home/.cargo"
8082
CARGO_TARGET_DIR: "/github/home/target"
8183

84+
# Run `cargo doc` to ensure the rustdoc is clean
85+
linux-rustdoc:
86+
name: cargo doc
87+
needs: linux-build-lib
88+
runs-on: ubuntu-latest
89+
container:
90+
image: amd64/rust
91+
steps:
92+
- uses: actions/checkout@v5
93+
- name: Setup Rust toolchain
94+
uses: ./.github/actions/setup-builder
95+
with:
96+
rust-version: stable
97+
- name: Run cargo doc
98+
run: ci/scripts/rust_docs.sh
99+
82100
linux-build-workspace:
83101
name: check linux workspace
84102
runs-on: ubuntu-latest
85103
container:
86104
image: amd64/rust
87105
steps:
88-
- uses: actions/checkout@v4
106+
- uses: actions/checkout@v5
89107
with:
90108
submodules: true
109+
fetch-depth: 1
91110
- name: Setup Rust toolchain
92111
uses: ./.github/actions/setup-builder
93112
- name: Try to compile when `--no-default-features` is selected
@@ -106,9 +125,10 @@ jobs:
106125
container:
107126
image: amd64/rust
108127
steps:
109-
- uses: actions/checkout@v4
128+
- uses: actions/checkout@v5
110129
with:
111130
submodules: true
131+
fetch-depth: 1
112132
- name: Setup Rust toolchain
113133
uses: ./.github/actions/setup-builder
114134
- name: Run Ballista tests
@@ -127,9 +147,10 @@ jobs:
127147
name: windows test
128148
runs-on: windows-latest
129149
steps:
130-
- uses: actions/checkout@v4
150+
- uses: actions/checkout@v5
131151
with:
132152
submodules: true
153+
fetch-depth: 1
133154
- name: Setup Rust toolchain
134155
uses: ./.github/actions/setup-windows-builder
135156
- name: Run tests
@@ -146,9 +167,10 @@ jobs:
146167
name: macos test
147168
runs-on: macos-latest
148169
steps:
149-
- uses: actions/checkout@v4
170+
- uses: actions/checkout@v5
150171
with:
151172
submodules: true
173+
fetch-depth: 1
152174
- name: Setup Rust toolchain
153175
uses: ./.github/actions/setup-macos-builder
154176
- name: Run tests
@@ -166,9 +188,10 @@ jobs:
166188
container:
167189
image: amd64/rust
168190
steps:
169-
- uses: actions/checkout@v4
191+
- uses: actions/checkout@v5
170192
with:
171193
submodules: true
194+
fetch-depth: 1
172195
- name: Setup Rust toolchain
173196
uses: ./.github/actions/setup-builder
174197
- name: Verify that benchmark queries return expected results
@@ -181,7 +204,7 @@ jobs:
181204
container:
182205
image: amd64/rust
183206
steps:
184-
- uses: actions/checkout@v4
207+
- uses: actions/checkout@v5
185208
- name: Setup toolchain
186209
run: |
187210
rustup toolchain install stable
@@ -207,9 +230,10 @@ jobs:
207230
# "1" means line tables only, which is useful for panic tracebacks.
208231
RUSTFLAGS: "-C debuginfo=1"
209232
steps:
210-
- uses: actions/checkout@v4
233+
- uses: actions/checkout@v5
211234
with:
212235
submodules: true
236+
fetch-depth: 1
213237
- name: Setup Rust toolchain
214238
uses: ./.github/actions/setup-builder
215239
with:
@@ -237,9 +261,10 @@ jobs:
237261
# "1" means line tables only, which is useful for panic tracebacks.
238262
RUSTFLAGS: "-C debuginfo=1"
239263
steps:
240-
- uses: actions/checkout@v4
264+
- uses: actions/checkout@v5
241265
with:
242266
submodules: true
267+
fetch-depth: 1
243268
- name: Setup Rust toolchain
244269
uses: ./.github/actions/setup-builder
245270
with:
@@ -274,7 +299,7 @@ jobs:
274299
# arch: [amd64]
275300
# rust: [stable]
276301
# steps:
277-
# - uses: actions/checkout@v4
302+
# - uses: actions/checkout@v5
278303
# with:
279304
# submodules: true
280305
# - name: Cache Cargo

‎ballista/core/src/client.rs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ impl BallistaClient {
141141
})
142142
}
143143

144+
#[allow(rustdoc::private_intra_doc_links)]
144145
/// Executes the specified action and retrieves the results from the remote executor.
145146
///
146147
/// This method establishes a [FlightDataStream] to facilitate the transfer of data
@@ -298,7 +299,7 @@ impl BallistaClient {
298299
/// compared to file-level compression, as it operates on smaller data segments.
299300
///
300301
/// For further discussion regarding performance implications, refer to:
301-
/// https://github.com/apache/datafusion-ballista/issues/1315
302+
/// <https://github.com/apache/datafusion-ballista/issues/1315>
302303
struct FlightDataStream {
303304
stream: Streaming<FlightData>,
304305
schema: SchemaRef,
@@ -346,14 +347,15 @@ impl RecordBatchStream for FlightDataStream {
346347
self.schema.clone()
347348
}
348349
}
350+
#[allow(rustdoc::private_intra_doc_links)]
349351
/// [BlockDataStream] facilitates the transfer of original shuffle files in a block-by-block manner.
350352
/// This implementation utilizes a custom `do_action` method on the Arrow Flight server.
351353
/// The primary distinction from [FlightDataStream] is that it does not decompress or decode
352354
/// the original partition file on the server side. This approach reduces computational overhead
353355
/// on the Flight server and enables the transmission of less data, owing to improved file-level compression.
354356
///
355357
/// For a detailed discussion of the performance advantages, see:
356-
/// https://github.com/apache/datafusion-ballista/issues/1315
358+
/// <https://github.com/apache/datafusion-ballista/issues/1315>
357359
pub struct BlockDataStream<S: Stream<Item = Result<prost::bytes::Bytes>> + Unpin> {
358360
decoder: StreamDecoder,
359361
state_buffer: Buffer,

‎ballista/executor/src/cpu_bound_executor.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ impl std::fmt::Debug for DedicatedExecutor {
8484
}
8585

8686
impl DedicatedExecutor {
87-
/// https://stackoverflow.com/questions/62536566
87+
/// <https://stackoverflow.com/questions/62536566>
8888
/// Creates a new `DedicatedExecutor` with a dedicated tokio
8989
/// runtime that is separate from the `[tokio::main]` threadpool.
9090
///

‎ballista/executor/src/executor.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ impl Executor {
110110
}
111111

112112
/// Create a new executor instance with given [RuntimeEnv],
113-
/// [ScalarUDF], [AggregateUDF] and [WindowUDF]
113+
/// [datafusion::logical_expr::ScalarUDF], [datafusion::logical_expr::AggregateUDF] and [datafusion::logical_expr::WindowUDF]
114114
#[allow(clippy::too_many_arguments)]
115115
pub fn new(
116116
metadata: ExecutorRegistration,

‎ballista/scheduler/src/cluster/mod.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ pub trait ClusterState: Send + Sync + 'static {
149149
Ok(())
150150
}
151151

152-
/// Bind the ready to running tasks from [`active_jobs`] with available executors.
152+
/// Bind the ready to running tasks from `active_jobs` with available executors.
153153
///
154154
/// If `executors` is provided, only bind slots from the specified executor IDs
155155
async fn bind_schedulable_tasks(

0 commit comments

Comments
 (0)