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 2024/07/26 07:30:16 UTC

(avro) branch fix-docs-issues-rust-1.80.0 created (now 3947ccfeb)

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

mgrigorov pushed a change to branch fix-docs-issues-rust-1.80.0
in repository https://gitbox.apache.org/repos/asf/avro.git


      at 3947ccfeb [NO JIRA] [Rust] Fix rustdoc formatting issues with Rust 1.80.0

This branch includes the following new commits:

     new 3947ccfeb [NO JIRA] [Rust] Fix rustdoc formatting issues with Rust 1.80.0

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(avro) 01/01: [NO JIRA] [Rust] Fix rustdoc formatting issues with Rust 1.80.0

Posted by mg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

mgrigorov pushed a commit to branch fix-docs-issues-rust-1.80.0
in repository https://gitbox.apache.org/repos/asf/avro.git

commit 3947ccfeb8ba565ed3167a4d01cadce5d1d32a0b
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
AuthorDate: Fri Jul 26 10:28:25 2024 +0300

    [NO JIRA] [Rust] Fix rustdoc formatting issues with Rust 1.80.0
    
    Signed-off-by: Martin Tzvetanov Grigorov <mg...@apache.org>
---
 lang/rust/avro/src/lib.rs | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/lang/rust/avro/src/lib.rs b/lang/rust/avro/src/lib.rs
index fa9ed5dd1..ec72741bf 100644
--- a/lang/rust/avro/src/lib.rs
+++ b/lang/rust/avro/src/lib.rs
@@ -38,8 +38,7 @@
 //! There are basically two ways of handling Avro data in Rust:
 //!
 //! * **as Avro-specialized data types** based on an Avro schema;
-//! * **as generic Rust serde-compatible types** implementing/deriving `Serialize` and
-//! `Deserialize`;
+//! * **as generic Rust serde-compatible types** implementing/deriving `Serialize` and `Deserialize`;
 //!
 //! **apache-avro** provides a way to read and write both these data representations easily and
 //! efficiently.
@@ -279,15 +278,15 @@
 //!
 //! * **Null**: leaves data uncompressed;
 //! * **Deflate**: writes the data block using the deflate algorithm as specified in RFC 1951, and
-//! typically implemented using the zlib library. Note that this format (unlike the "zlib format" in
-//! RFC 1950) does not have a checksum.
+//!   typically implemented using the zlib library. Note that this format (unlike the "zlib format" in
+//!   RFC 1950) does not have a checksum.
 //! * **Snappy**: uses Google's [Snappy](http://google.github.io/snappy/) compression library. Each
-//! compressed block is followed by the 4-byte, big-endianCRC32 checksum of the uncompressed data in
-//! the block. You must enable the `snappy` feature to use this codec.
+//!   compressed block is followed by the 4-byte, big-endianCRC32 checksum of the uncompressed data in
+//!   the block. You must enable the `snappy` feature to use this codec.
 //! * **Zstandard**: uses Facebook's [Zstandard](https://facebook.github.io/zstd/) compression library.
-//! You must enable the `zstandard` feature to use this codec.
+//!   You must enable the `zstandard` feature to use this codec.
 //! * **Bzip2**: uses [BZip2](https://sourceware.org/bzip2/) compression library.
-//! You must enable the `bzip` feature to use this codec.
+//!   You must enable the `bzip` feature to use this codec.
 //! * **Xz**: uses [xz2](https://github.com/alexcrichton/xz2-rs) compression library.
 //!   You must enable the `xz` feature to use this codec.
 //!
@@ -803,14 +802,14 @@
 //!
 //! The library provides two implementations of schema equality comparators:
 //! 1. `SpecificationEq` - a comparator that serializes the schemas to their
-//! canonical forms (i.e. JSON) and compares them as strings. It is the only implementation
-//! until apache_avro 0.16.0.
-//! See the [Avro specification](https://avro.apache.org/docs/1.11.1/specification/#parsing-canonical-form-for-schemas)
-//! for more information!
+//!    canonical forms (i.e. JSON) and compares them as strings. It is the only implementation
+//!    until apache_avro 0.16.0.
+//!    See the [Avro specification](https://avro.apache.org/docs/1.11.1/specification/#parsing-canonical-form-for-schemas)
+//!    for more information!
 //! 2. `StructFieldEq` - a comparator that compares the schemas structurally.
-//! It is faster than the `SpecificationEq` because it returns `false` as soon as a difference
-//! is found and is recommended for use!
-//! It is the default comparator since apache_avro 0.17.0.
+//!    It is faster than the `SpecificationEq` because it returns `false` as soon as a difference
+//!    is found and is recommended for use!
+//!    It is the default comparator since apache_avro 0.17.0.
 //!
 //! To use a custom comparator, you need to implement the `SchemataEq` trait and set it using the
 //! `set_schemata_equality_comparator` function: