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 a0f010b  fix: Fix links rustdoc (#505)
a0f010b is described below

commit a0f010b304a459b83e6ff3b35fc1f0194c71c164
Author: Martin Grigorov <[email protected]>
AuthorDate: Fri Mar 6 08:25:56 2026 +0200

    fix: Fix links rustdoc (#505)
    
    ```
    warning: unresolved link to `Writer`
       --> avro/src/writer/datum.rs:156:20
        |
    156 | /// markers; use [`Writer`] to be fully Avro-compatible if you don't 
know what
        |                    ^^^^^^ no item named `Writer` in scope
        |
        = help: to escape `[` and `]` characters, add '\' before them like `\[` 
or `\]`
        = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
    
    warning: unresolved link to `Writer::append_ser`
       --> avro/src/writer/datum.rs:172:33
        |
    172 | /// markers; use [`append_ser`](Writer::append_ser) to be fully 
Avro-compatible
        |                                 ^^^^^^^^^^^^^^^^^^ no item named 
`Writer` in scope
    ```
    
    Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
---
 avro/src/writer/datum.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/avro/src/writer/datum.rs b/avro/src/writer/datum.rs
index 3019554..539c894 100644
--- a/avro/src/writer/datum.rs
+++ b/avro/src/writer/datum.rs
@@ -155,6 +155,8 @@ impl GenericDatumWriter<'_> {
 /// **NOTE**: This function has a quite small niche of usage and does NOT 
generate headers and sync
 /// markers; use [`Writer`] to be fully Avro-compatible if you don't know what
 /// you are doing, instead.
+///
+/// [`Writer`]: crate::Writer
 #[deprecated(since = "0.22.0", note = "Use GenericDatumWriter instead")]
 pub fn to_avro_datum<T: Into<Value>>(schema: &Schema, value: T) -> 
AvroResult<Vec<u8>> {
     GenericDatumWriter::builder(schema)
@@ -169,8 +171,10 @@ pub fn to_avro_datum<T: Into<Value>>(schema: &Schema, 
value: T) -> AvroResult<Ve
 /// Returns a result with the number of bytes written.
 ///
 /// **NOTE**: This function has a quite small niche of usage and does **NOT** 
generate headers and sync
-/// markers; use [`append_ser`](Writer::append_ser) to be fully Avro-compatible
+/// markers; use [`Writer::append_ser`] to be fully Avro-compatible
 /// if you don't know what you are doing, instead.
+///
+/// [`Writer::append_ser`]: crate::Writer::append_ser
 pub fn write_avro_datum_ref<T: Serialize, W: Write>(
     schema: &Schema,
     names: &NamesRef,

Reply via email to