You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@avro.apache.org by mg...@apache.org on 2022/12/16 07:31:19 UTC

[avro] 02/03: Fix lint warning in rustdoc

This is an automated email from the ASF dual-hosted git repository.

mgrigorov pushed a commit to branch fix-minor-warnings-from-rust-1.66.0
in repository https://gitbox.apache.org/repos/asf/avro.git

commit 410c031e1ecec2ab478f7f01efcec19dc86f02b1
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
AuthorDate: Fri Dec 16 09:26:46 2022 +0200

    Fix lint warning in rustdoc
    
    warning: unclosed HTML tag `Value`
       --> avro/src/writer.rs:459:23
        |
    459 |     /// Write the Into<Value> to the provided Write object. Returns a result with the number
        |                       ^^^^^^^
        |
        = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
    help: try marking as source code
        |
    459 |     /// Write the `Into<Value>` to the provided Write object. Returns a result with the number
        |                   +           +
    
    warning: `apache-avro` (lib doc) generated 1 warning
    
    Signed-off-by: Martin Tzvetanov Grigorov <mg...@apache.org>
---
 lang/rust/avro/src/writer.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lang/rust/avro/src/writer.rs b/lang/rust/avro/src/writer.rs
index 3bc5c5122..82a5b1387 100644
--- a/lang/rust/avro/src/writer.rs
+++ b/lang/rust/avro/src/writer.rs
@@ -456,7 +456,7 @@ impl<T> SpecificSingleObjectWriter<T>
 where
     T: AvroSchema + Into<Value>,
 {
-    /// Write the Into<Value> to the provided Write object. Returns a result with the number
+    /// Write the `Into<Value>` to the provided Write object. Returns a result with the number
     /// of bytes written including the header
     pub fn write_value<W: Write>(&mut self, data: T, writer: &mut W) -> AvroResult<usize> {
         let v: Value = data.into();