Merge pull request #33311 from def-/pr-doc-deploy

Fix cargo docs following new nightly version

Author: def-

ci/plugins/cloudtest/hooks/command

@@ -162,7 +162,7 @@ cleanup() {
   mapfile -t artifacts < <(printf "run.log\nkubectl-get-logs.log\nkubectl-get-logs-previous.log\nkubectl-get-events.log\nkubectl-get-all.log\nkubectl-describe-all.log\nkubectl-pods-with-nodes.log\nkubectl-get-events-kube-system.log\nkubectl-get-all-kube-system.log\nkubectl-describe-all-kube-system.log\njournalctl-merge.log\nkail-output.log\n"; find . -name 'junit_*.xml')
 
   {
-    bin/ci-builder run stable trufflehog --no-update --no-verification --json --exclude-detectors=coda,dockerhub,box,npmtoken,github,snykkey,eightxeight,sumologickey,miro,fmfw,logzio,qase,cannyio filesystem "${artifacts[@]}" | trufflehog_jq_filter_logs > trufflehog.log
+    bin/ci-builder run stable trufflehog --no-update --no-verification --json --exclude-detectors=coda,dockerhub,box,npmtoken,github,snykkey,eightxeight,sumologickey,miro,fmfw,logzio,qase,cannyio,uplead filesystem "${artifacts[@]}" | trufflehog_jq_filter_logs > trufflehog.log
   } &
   artifacts_str=$(IFS=";"; echo "${artifacts[*]}")
 

ci/plugins/mzcompose/hooks/command

@@ -176,7 +176,7 @@ cleanup() {
 
   echo "--- Running trufflehog to scan artifacts for secrets & uploading artifacts"
   {
-    bin/ci-builder run "$builder" trufflehog --no-update --no-verification --json --exclude-detectors=coda,dockerhub,box,npmtoken,github,snykkey,eightxeight,sumologickey,miro,fmfw,logzio,qase,cannyio filesystem "${artifacts[@]}" | trufflehog_jq_filter_logs > trufflehog.log
+    bin/ci-builder run "$builder" trufflehog --no-update --no-verification --json --exclude-detectors=coda,dockerhub,box,npmtoken,github,snykkey,eightxeight,sumologickey,miro,fmfw,logzio,qase,cannyio,uplead filesystem "${artifacts[@]}" | trufflehog_jq_filter_logs > trufflehog.log
   } &
 
   unset CI_EXTRA_ARGS # We don't want extra args for the annotation

src/adapter/src/session.rs

@@ -89,7 +89,7 @@ where
     /// Invariant: role_metadata must be `Some` after the user has
     /// successfully connected to and authenticated with Materialize.
     ///
-    /// Prefer using this value over [`Self.user.name`].
+    /// Prefer using this value over [`SessionConfig::user`].
     //
     // It would be better for this not to be an Option, but the
     // `Session` is initialized before the user has connected to

src/build-tools/src/lib.rs

@@ -11,7 +11,7 @@
 //!
 //! For example, many crates have a build script that depends on the Protobuf
 //! compiler, `protoc`. If we're building with Cargo we'll bootstrap `protoc`
-//! by compiling it with [`protobuf-src`], but if we're building with Bazel
+//! by compiling it with `protobuf-src`, but if we're building with Bazel
 //! then we'll use the version of `protoc` included in the runfiles.
 
 use cfg_if::cfg_if;

src/cloud-api/src/lib.rs

@@ -50,7 +50,7 @@
 //!
 //! ## Note
 //!
-//! This crate is implemented following a similar pattern to [`mz-frontegg-client`], [rust-orb-billing] and [rust-frontegg].
+//! This crate is implemented following a similar pattern to `mz-frontegg-client`, [rust-orb-billing] and [rust-frontegg].
 //!
 //! [mz-frontegg-client]:
 //! [rust-orb-billing]: <https://github.com/MaterializeInc/rust-orb-billing>

src/controller/src/lib.rs

@@ -183,7 +183,7 @@ pub struct Controller<T: ComputeControllerTimestamp = mz_repr::Timestamp> {
     /// A map associating a global ID to the set of all the unfulfilled watch
     /// set ids that include it.
     ///
-    /// See [`self.install_watch_set`] for a description of watch sets.
+    /// See [`Controller::install_compute_watch_set`]/[`Controller::install_storage_watch_set`] for a description of watch sets.
     // When a watch set is fulfilled for a given object (that is, when
     // the object's frontier advances to at least the watch set's
     // timestamp), the corresponding entry will be removed from the set.
@@ -195,9 +195,9 @@ pub struct Controller<T: ComputeControllerTimestamp = mz_repr::Timestamp> {
 
     /// A list of watch sets that were already fulfilled as soon as
     /// they were installed, and thus that must be returned to the
-    /// client on the next call to [`self.process`].
+    /// client on the next call to [`Controller::process_compute_response`]/[`Controller::process_storage_response`].
     ///
-    /// See [`self.install_watch_set`] for a description of watch sets.
+    /// See [`Controller::install_compute_watch_set`]/[`Controller::install_storage_watch_set`] for a description of watch sets.
     immediate_watch_sets: Vec<WatchSetId>,
 
     /// Dynamic system configuration.

src/frontegg-client/src/error.rs

@@ -18,7 +18,7 @@
 //!
 //! It contains three variants:
 //! * [`Error::Auth`]: represents an authentication error from the
-//!   [`mz-frontegg-auth`] crate.
+//!   `mz-frontegg-auth` crate.
 //! * [`Error::Transport`]: represents a transport error from the `reqwest`
 //!   crate during a network request.
 //! * [`Error::Api`]: represents an Frontegg API error from a request.

src/interchange/src/avro/decode.rs

@@ -7,16 +7,13 @@
 // the Business Source License, use of this software will be governed
 // by the Apache License, Version 2.0.
 
-use std::cell::RefCell;
 use std::collections::BTreeMap;
-use std::rc::Rc;
 
 use anyhow::{Context, Error};
 use mz_avro::error::{DecodeError, Error as AvroError};
 use mz_avro::{
     AvroArrayAccess, AvroDecode, AvroDeserializer, AvroMapAccess, AvroRead, AvroRecordAccess,
-    GeneralDeserializer, StatefulAvroDecodable, ValueDecoder, ValueOrReader, define_unexpected,
-    give_value,
+    GeneralDeserializer, ValueDecoder, ValueOrReader, give_value,
 };
 use mz_ore::error::ErrorExt;
 use mz_repr::adt::date::Date;
@@ -133,47 +130,6 @@ impl Decoder {
     }
 }
 
-pub(super) struct RowDecoder {
-    state: (Rc<RefCell<Row>>, Rc<RefCell<Vec<u8>>>),
-}
-
-impl AvroDecode for RowDecoder {
-    type Out = RowWrapper;
-    fn record<R: AvroRead, A: AvroRecordAccess<R>>(
-        self,
-        a: &mut A,
-    ) -> Result<Self::Out, AvroError> {
-        let mut row_borrow = self.state.0.borrow_mut();
-        let mut buf_borrow = self.state.1.borrow_mut();
-        let mut packer = row_borrow.packer();
-        let inner = AvroFlatDecoder {
-            packer: &mut packer,
-            buf: &mut buf_borrow,
-            is_top: true,
-        };
-        inner.record(a)?;
-        Ok(RowWrapper(row_borrow.clone()))
-    }
-    define_unexpected! {
-        union_branch, array, map, enum_variant, scalar, decimal, bytes, string, json, uuid, fixed
-    }
-}
-
-// Get around orphan rule
-#[derive(Debug)]
-pub(super) struct RowWrapper(#[allow(dead_code)] pub Row);
-
-impl StatefulAvroDecodable for RowWrapper {
-    type Decoder = RowDecoder;
-    // TODO - can we make this some sort of &'a mut (Row, Vec<u8>) without
-    // running into lifetime crap?
-    type State = (Rc<RefCell<Row>>, Rc<RefCell<Vec<u8>>>);
-
-    fn new_decoder(state: Self::State) -> Self::Decoder {
-        Self::Decoder { state }
-    }
-}
-
 #[derive(Debug)]
 pub struct AvroFlatDecoder<'a, 'row> {
     pub packer: &'a mut RowPacker<'row>,

src/ore/src/cast.rs

@@ -60,7 +60,7 @@ macro_rules! cast_from {
                 }
             }
 
-            /// Casts [`$from`] to [`$to`].
+            /// Casts `from` to `to`.
             ///
             /// This is equivalent to the [`crate::cast::CastFrom`] implementation but is
             /// available as a `const fn`.

src/sql-parser/src/ast/defs/name.rs

@@ -275,7 +275,7 @@ impl Ident {
     }
 
     /// An identifier can be printed in bare mode if
-    ///  * it matches the regex [a-z_][a-z0-9_]* and
+    ///  * it matches the regex `[a-z_][a-z0-9_]*` and
     ///  * it is not a "reserved keyword."
     pub fn can_be_printed_bare(&self) -> bool {
         let mut chars = self.0.chars();