This is an automated email from the ASF dual-hosted git repository.
mgrigorov pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/avro-rs.git
The following commit(s) were added to refs/heads/main by this push:
new b020ea7 ci: Add a CI step for `cargo doc` (#507)
b020ea7 is described below
commit b020ea776b288ac81631ace041b78dc705307a2f
Author: Martin Grigorov <[email protected]>
AuthorDate: Fri Mar 6 10:09:48 2026 +0200
ci: Add a CI step for `cargo doc` (#507)
---
.github/workflows/test-lang-rust-ci.yml | 9 ++++++++-
avro/src/bytes.rs | 4 ++--
avro/src/schema_compatibility.rs | 2 +-
avro/src/serde/ser_schema/mod.rs | 4 ++--
4 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/test-lang-rust-ci.yml
b/.github/workflows/test-lang-rust-ci.yml
index 380366b..dda72a0 100644
--- a/.github/workflows/test-lang-rust-ci.yml
+++ b/.github/workflows/test-lang-rust-ci.yml
@@ -98,10 +98,17 @@ jobs:
# Check if the doc cumment in avro/src/lib.rs and avro/README.md are in
sync.
- name: Run cargo-rdme
- # The result is environment independent so one test pattern is enough.
+ # The result is environment independent, so one test pattern is enough.
if: matrix.rust == 'stable' && matrix.runner.target ==
'x86_64-unknown-linux-gnu'
run: cargo rdme --check
+ - name: Run cargo doc
+ # The result is environment independent, so one test pattern is enough.
+ if: matrix.rust == 'nightly' && matrix.runner.target ==
'x86_64-unknown-linux-gnu'
+ env:
+ RUSTDOCFLAGS: --cfg docsrs -Dwarnings
+ run: cargo doc --lib --no-deps --document-private-items --features
derive
+
- name: Rust Format
if: matrix.runner.target != 'wasm32-unknown-unknown'
run: cargo fmt --all --check
diff --git a/avro/src/bytes.rs b/avro/src/bytes.rs
index 341b01d..c61f124 100644
--- a/avro/src/bytes.rs
+++ b/avro/src/bytes.rs
@@ -15,9 +15,9 @@
// specific language governing permissions and limitations
// under the License.
-//! Deprecated. Use [`apache_avro::serde::*`] instead.
+//! Deprecated. Use [`apache_avro::serde`] instead.
//!
-//! [`apache_avro::serde::*`](crate::serde)
+//! [`apache_avro::serde`](crate::serde)
#[cfg(doc)]
use crate as apache_avro;
diff --git a/avro/src/schema_compatibility.rs b/avro/src/schema_compatibility.rs
index 8baafd3..2578551 100644
--- a/avro/src/schema_compatibility.rs
+++ b/avro/src/schema_compatibility.rs
@@ -170,7 +170,7 @@ impl Checker {
hasher.finish()
}
- /// The actual implementation of [`full_match_schemas`] but without the
recursion protection.
+ /// The actual implementation of "`full_match_schemas()`" but without the
recursion protection.
///
/// This function should never be called directly as it can recurse
infinitely on recursive types.
#[rustfmt::skip]
diff --git a/avro/src/serde/ser_schema/mod.rs b/avro/src/serde/ser_schema/mod.rs
index 070f562..fa9382f 100644
--- a/avro/src/serde/ser_schema/mod.rs
+++ b/avro/src/serde/ser_schema/mod.rs
@@ -430,8 +430,8 @@ impl<W: Write> ser::SerializeStruct for
SchemaAwareWriteSerializeStruct<'_, '_,
/// This implementation is used to support `#[serde(flatten)]` as that uses
[`SerializeMap`] instead of [`SerializeStruct`].
///
-/// [`SerializeMap`](ser::SerializeMap)
-/// [`SerializeStruct`](ser::SerializeStruct)
+/// [`SerializeMap`]: ser::SerializeMap
+/// [`SerializeStruct`]: ser::SerializeStruct
impl<W: Write> ser::SerializeMap for SchemaAwareWriteSerializeStruct<'_, '_,
W> {
type Ok = usize;
type Error = Error;
