Skip to content

Commit 0fdaca3

Browse files
committed
fix(dir-structure): fix docs for the *_pretty data_formats
1 parent e169fa7 commit 0fdaca3

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/dev/dir-structure/src/data_formats.rs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
macro_rules! data_format_impl {
44
(
55
$(#[$mod_attr:meta])*
6-
$mod_name:ident,
6+
$mod_name:ident $core_name:ident,
77
$(#[$main_ty_attrs:meta])*
88
$main_ty:ident,
99

@@ -25,15 +25,15 @@ macro_rules! data_format_impl {
2525
$(#[$mod_attr])*
2626
pub mod $mod_name {
2727
#![doc = concat!(r##"
28-
With the `"##, stringify!($mod_name), r##"` feature, this module provides the [`"##, stringify!($main_ty), r##"`] type.
28+
With the `"##, stringify!($core_name), r##"` feature, this module provides the [`"##, stringify!($main_ty), r##"`] type.
2929
30-
This allows us to read and parse `"##, stringify!($mod_name), r##"` files to some `serde::Deserialize` type,
30+
This allows us to read and parse `"##, stringify!($core_name), r##"` files to some `serde::Deserialize` type,
3131
and write them back to disk."##
3232
)]
3333
//!
3434
//! # Examples
3535
//!
36-
#![doc = concat!(r##"## Reading a "##, stringify!($mod_name), r##" file"##)]
36+
#![doc = concat!(r##"## Reading a "##, stringify!($core_name), r##" file"##)]
3737
//!
3838
#![cfg_attr(feature = "derive", doc = "```rust")]
3939
#![cfg_attr(not(feature = "derive"), doc = "```rust,compile_fail")]
@@ -65,7 +65,7 @@ and write them back to disk."##
6565
//! }
6666
//! ```
6767
//!
68-
#![doc = concat!(r##"## Writing a "##, stringify!($mod_name), r##" file"##)]
68+
#![doc = concat!(r##"## Writing a "##, stringify!($core_name), r##" file"##)]
6969
//!
7070
#![cfg_attr(feature = "derive", doc = "```rust")]
7171
#![cfg_attr(not(feature = "derive"), doc = "```rust,compile_fail")]
@@ -357,7 +357,7 @@ data_format_impl!(
357357
#[cfg(feature = "json")]
358358
#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
359359
#[allow(clippy::absolute_paths)]
360-
json,
360+
json json,
361361
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
362362
/// thus allowing us to parse and serialize it from / to json when we read / write a
363363
/// directory structure.
@@ -377,7 +377,7 @@ data_format_impl!(
377377
#[cfg(feature = "json")]
378378
#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
379379
#[allow(clippy::absolute_paths)]
380-
json_pretty,
380+
json_pretty json,
381381
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
382382
/// thus allowing us to parse and serialize it from / to json when we read / write a
383383
/// directory structure.
@@ -402,7 +402,7 @@ data_format_impl!(
402402
#[cfg(feature = "toml")]
403403
#[cfg_attr(docsrs, doc(cfg(feature = "toml")))]
404404
#[allow(clippy::absolute_paths)]
405-
toml,
405+
toml toml,
406406
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
407407
/// thus allowing us to parse and serialize it from / to toml when we read / write a
408408
/// directory structure.
@@ -429,7 +429,7 @@ data_format_impl!(
429429
#[cfg(feature = "yaml")]
430430
#[cfg_attr(docsrs, doc(cfg(feature = "yaml")))]
431431
#[allow(clippy::absolute_paths)]
432-
yaml,
432+
yaml yaml,
433433
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
434434
/// thus allowing us to parse and serialize it from / to yaml when we read / write a
435435
/// directory structure.
@@ -452,7 +452,7 @@ data_format_impl!(
452452
#[cfg(feature = "ron")]
453453
#[cfg_attr(docsrs, doc(cfg(feature = "ron")))]
454454
#[allow(clippy::absolute_paths)]
455-
ron,
455+
ron ron,
456456
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
457457
/// thus allowing us to parse and serialize it from / to ron when we read / write a
458458
/// directory structure.
@@ -472,7 +472,7 @@ data_format_impl!(
472472
#[cfg(feature = "ron")]
473473
#[cfg_attr(docsrs, doc(cfg(feature = "ron")))]
474474
#[allow(clippy::absolute_paths)]
475-
ron_pretty,
475+
ron_pretty ron,
476476
/// A wrapper around a type that implements [`serde::Serialize`] and [`serde::Deserialize`],
477477
/// thus allowing us to parse and serialize it from / to ron when we read / write a
478478
/// directory structure.

0 commit comments

Comments
 (0)