Skip to content

Commit

Permalink
chore: addressed warnings in docs generation (#252)
Browse files Browse the repository at this point in the history
  • Loading branch information
dj8yfo authored Oct 24, 2023
1 parent e8d67c9 commit f1f820b
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 20 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ jobs:
- name: print rustc version
run: rustc --version
# remove this step when MSRV >= 1.67.0
- name: downgrade `time` crate to support older Rust toolchain
- name: downgrade `time`, `toml_datetime` crate to support older Rust toolchain
if: matrix.rust_version == '1.66.0'
run: cargo update -p time --precise 0.3.23
run: |
cargo update -p time --precise 0.3.23
cargo update -p toml_datetime --precise 0.6.3
- name: Run tests
run: ./.github/test.sh

Expand Down
8 changes: 4 additions & 4 deletions borsh-derive/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ struct A<U, V> {
###### syntax
Attribute takes literal string value, which is the [Path](syn::Path) to `borsh` crate used.
Attribute takes literal string value, which is the syn's [Path] to `borsh` crate used.
###### usage
Expand Down Expand Up @@ -354,7 +354,7 @@ struct A<U, V> {
###### syntax
Attribute takes literal string value, which is the [Path](syn::Path) to `borsh` crate used.
Attribute takes literal string value, which is the syn's [Path] to `borsh` crate used.
###### usage
Expand Down Expand Up @@ -407,7 +407,7 @@ struct B {
###### syntax
Attribute's value is syn's [Path](syn::Path)-s, passed to borsh top level meta attribute as value of `init` argument.
Attribute's value is syn's [Path]-s, passed to borsh top level meta attribute as value of `init` argument.
###### usage
Expand Down Expand Up @@ -690,7 +690,7 @@ struct A<U, V> {
###### syntax
Attribute takes literal string value, which is the [Path](syn::Path) to `borsh` crate used.
Attribute takes literal string value, which is the syn's [Path] to `borsh` crate used.
###### usage
Expand Down
2 changes: 1 addition & 1 deletion borsh/src/de/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ where
#[cfg(hash_collections)]
pub mod hashes {
//!
//! Module defines [BorshDeserialize](crate::de::BorshDeserialize) implementation for
//! Module defines [BorshDeserialize] implementation for
//! [HashMap](std::collections::HashMap)/[HashSet](std::collections::HashSet).
use core::hash::{BuildHasher, Hash};

Expand Down
22 changes: 11 additions & 11 deletions borsh/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,40 +25,40 @@
### Other features
* **derive** -
Gates derive macros of [BorshSerialize](crate::ser::BorshSerialize) and
[BorshDeserialize](crate::de::BorshDeserialize) traits.
Gates derive macros of [BorshSerialize] and
[BorshDeserialize] traits.
* **unstable__schema** -
Gates [BorshSchema](crate::schema::BorshSchema) trait and its derive macro.
Gates [schema](crate::schema) module.
Gates [BorshSchema] trait and its derive macro.
Gates [schema] module.
This feature requires **derive** to be enabled too.
* **rc** -
Gates implementation of [BorshSerialize](crate::ser::BorshSerialize) and [BorshDeserialize](crate::de::BorshDeserialize)
Gates implementation of [BorshSerialize] and [BorshDeserialize]
for [`Rc<T>`](std::rc::Rc)/[`Arc<T>`](std::sync::Arc) respectively.
In `no_std` setting `Rc`/`Arc` are pulled from `alloc` crate.
* **hashbrown** -
Pulls in [HashMap](std::collections::HashMap)/[HashSet](std::collections::HashSet) when no `std` is available.
This feature is set to be mutually exclusive with **std** feature.
* **bytes** -
Gates implementation of [BorshSerialize](crate::ser::BorshSerialize) and [BorshDeserialize](crate::de::BorshDeserialize)
Gates implementation of [BorshSerialize] and [BorshDeserialize]
for [Bytes](bytes::Bytes) and [BytesMut](bytes::BytesMut).
* **bson** -
Gates implementation of [BorshSerialize](crate::ser::BorshSerialize) and [BorshDeserialize](crate::de::BorshDeserialize)
Gates implementation of [BorshSerialize] and [BorshDeserialize]
for [ObjectId](bson::oid::ObjectId).
* **de_strict_order** -
Enables check that keys, parsed during deserialization of
[HashMap](std::collections::HashMap)/[HashSet](std::collections::HashSet) and
[BTreeSet](std::collections::BTreeSet)/[BTreeMap](std::collections::BTreeMap)
are encountered in ascending order with respect to [PartialOrd](core::cmp::PartialOrd) for hash collections,
and [Ord](core::cmp::Ord) for btree ones. Deserialization emits error otherwise.
are encountered in ascending order with respect to [PartialOrd] for hash collections,
and [Ord] for btree ones. Deserialization emits error otherwise.
If this feature is not enabled, it is possible that two different byte slices could deserialize into the same `HashMap`/`HashSet` object.
### Config aliases
* **hash_collections** -
This is a feature alias, set up in `build.rs` to be equivalent to (**std** OR **hashbrown**).
Gates implementation of [BorshSerialize](crate::ser::BorshSerialize), [BorshDeserialize](crate::de::BorshDeserialize)
and [BorshSchema](crate::schema::BorshSchema)
Gates implementation of [BorshSerialize], [BorshDeserialize]
and [BorshSchema]
for [HashMap](std::collections::HashMap)/[HashSet](std::collections::HashSet).
Expand Down
2 changes: 1 addition & 1 deletion borsh/src/schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ where
#[cfg(hash_collections)]
pub mod hashes {
//!
//! Module defines [BorshSchema](crate::schema::BorshSchema) implementation for
//! Module defines [BorshSchema] implementation for
//! [HashMap](std::collections::HashMap)/[HashSet](std::collections::HashSet).
use crate::BorshSchema;

Expand Down
2 changes: 1 addition & 1 deletion borsh/src/ser/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ where
#[cfg(hash_collections)]
pub mod hashes {
//!
//! Module defines [BorshSerialize](crate::ser::BorshSerialize) implementation for
//! Module defines [BorshSerialize] implementation for
//! [HashMap](std::collections::HashMap)/[HashSet](std::collections::HashSet).
use crate::__private::maybestd::vec::Vec;
use crate::error::check_zst;
Expand Down

0 comments on commit f1f820b

Please sign in to comment.