Skip to content

Commit

Permalink
Merge pull request #363 from Fraser999/update-rustdocs
Browse files Browse the repository at this point in the history
Mention cyclic dependency in main rustdocs
  • Loading branch information
cuviper authored Dec 16, 2024
2 parents 539b401 + 779505f commit 31c9862
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,11 @@
//! (de)serializing [`IndexMap`] as an ordered sequence are available in the
//! [`map::serde_seq`] module.
//! * `borsh`: Adds implementations for [`BorshSerialize`] and [`BorshDeserialize`]
//! to [`IndexMap`] and [`IndexSet`].
//! to [`IndexMap`] and [`IndexSet`]. **Note:** When this feature is enabled,
//! you cannot enable the `derive` feature of [`borsh`] due to a cyclic
//! dependency. Instead, add the `borsh-derive` crate as an explicit
//! dependency in your Cargo.toml and import as e.g.
//! `use borsh_derive::{BorshSerialize, BorshDeserialize};`.
//! * `arbitrary`: Adds implementations for the [`arbitrary::Arbitrary`] trait
//! to [`IndexMap`] and [`IndexSet`].
//! * `quickcheck`: Adds implementations for the [`quickcheck::Arbitrary`] trait
Expand All @@ -50,6 +54,7 @@
//! [`Deserialize`]: `::serde::Deserialize`
//! [`BorshSerialize`]: `::borsh::BorshSerialize`
//! [`BorshDeserialize`]: `::borsh::BorshDeserialize`
//! [`borsh`]: `::borsh`
//! [`arbitrary::Arbitrary`]: `::arbitrary::Arbitrary`
//! [`quickcheck::Arbitrary`]: `::quickcheck::Arbitrary`
//!
Expand Down

0 comments on commit 31c9862

Please sign in to comment.