chore: Fix all rustdoc warnings and enforce no warning in CI (#4261)

Signed-off-by: Adam Gutglick <[email protected]>

Author: AdamGS

.github/workflows/ci.yml

@@ -133,7 +133,7 @@ jobs:
       - uses: ./.github/actions/setup-rust
       - name: Docs
         run: |
-          cargo doc --no-deps
+          RUSTDOCFLAGS="-D warnings" cargo doc --no-deps
           # nextest doesn't support doc tests, so we run it here
           cargo test --doc --workspace --all-features --exclude vortex-cxx --exclude vortex-python --exclude vortex-jni --exclude vortex-ffi --exclude xtask --no-fail-fast
 

vortex-datafusion/src/persistent/source.rs

@@ -34,9 +34,9 @@ use super::metrics::PARTITION_LABEL;
 use super::opener::VortexOpener;
 use crate::convert::exprs::can_be_pushed_down;
 
-/// A config for [`VortexFileOpener`]. Used to create [`DataSourceExec`] based physical plans.
+/// Execution plan for reading one or more Vortex files, intended to be consumed by [`DataSourceExec`].
 ///
-/// [`DataSourceExec`]: datafusion::datasource::source::DataSourceExec
+/// [`DataSourceExec`]: datafusion_datasource::source::DataSourceExec
 #[derive(Clone)]
 pub struct VortexSource {
     pub(crate) file_cache: VortexFileCache,

vortex-file/src/strategy.rs

@@ -37,7 +37,7 @@ impl Default for WriteStrategyBuilder {
 
 impl WriteStrategyBuilder {
     /// Create a new empty builder. It can be further configured, and then finally built
-    /// yielding the [`WriteStrategy`].
+    /// yielding the [`LayoutStrategy`].
     pub const fn new() -> Self {
         Self {
             executor: None,

vortex-layout/src/layouts/compressed.rs

@@ -81,6 +81,8 @@ impl<S: LayoutStrategy> CompressingStrategy<S> {
     /// This may create smaller files than the BtrBlocks writer, in exchange for some penalty
     /// to decoding performance. This is only recommended for datasets that make heavy use of
     /// floating point numbers.
+    ///
+    /// [`CompactCompressor`]: crate::layouts::compact::CompactCompressor
     #[cfg(feature = "zstd")]
     pub fn new_compact(
         child: S,

vortex-scan/src/lib.rs

@@ -210,7 +210,7 @@ impl<A: 'static + Send> ScanBuilder<A> {
         Ok(split_tasks)
     }
 
-    /// Returns a [`Stream`] with tasks spawned onto the current Tokio runtime.
+    /// Returns a [`Stream`](futures::Stream) with tasks spawned onto the current Tokio runtime.
     ///
     /// The stream performs CPU work on the polling thread, with I/O operations dispatched as
     /// per the Vortex I/O traits.
@@ -279,6 +279,8 @@ impl ScanBuilder<ArrayRef> {
     /// Returns an [`ArrayStream`] with tasks spawned onto the current Tokio runtime.
     ///
     /// See [`ScanBuilder::into_tokio_stream`] for more details.
+    ///
+    /// [`ArrayStream`]: vortex_array::stream::ArrayStreamAdapter
     #[cfg(feature = "tokio")]
     pub fn into_tokio_array_stream(
         self,