Skip to content

Commit 32411d3

Browse files
committed
scylla: Add separators in derive macros docs
Rustdocs merges documentation of re-exports with documentation of original item. Because of this there is a need for separator, so that stubs from scylla-macros crate are not mixed up with docs present in scylla crate.
1 parent 5c7c12b commit 32411d3

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

scylla/src/macros.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
11
/// #[derive(FromRow)] derives FromRow for struct
22
/// Works only on simple structs without generics etc
3+
///
4+
/// ---
5+
///
36
pub use scylla_cql::macros::FromRow;
47

58
/// #[derive(FromUserType)] allows to parse struct as a User Defined Type
69
/// Works only on simple structs without generics etc
10+
///
11+
/// ---
12+
///
713
pub use scylla_cql::macros::FromUserType;
814

915
/// #[derive(IntoUserType)] allows to pass struct a User Defined Type Value in queries
1016
/// Works only on simple structs without generics etc
17+
///
18+
/// ---
19+
///
1120
pub use scylla_cql::macros::IntoUserType;
1221

1322
/// Derive macro for the [`SerializeCql`](crate::serialize::value::SerializeCql) trait
@@ -117,6 +126,9 @@ pub use scylla_cql::macros::IntoUserType;
117126
/// `#[scylla(skip)]`
118127
///
119128
/// Don't use the field during serialization.
129+
///
130+
/// ---
131+
///
120132
pub use scylla_cql::macros::SerializeCql;
121133

122134
/// Derive macro for the [`SerializeRow`](crate::serialize::row::SerializeRow) trait
@@ -214,9 +226,15 @@ pub use scylla_cql::macros::SerializeCql;
214226
/// `#[scylla(skip)]`
215227
///
216228
/// Don't use the field during serialization.
229+
///
230+
/// ---
231+
///
217232
pub use scylla_cql::macros::SerializeRow;
218233

219234
/// #[derive(ValueList)] allows to pass struct as a list of values for a query
235+
///
236+
/// ---
237+
///
220238
pub use scylla_cql::macros::ValueList;
221239

222240
pub use scylla_cql::macros::impl_from_cql_value_from_method;

0 commit comments

Comments
 (0)