Remove all doc_comment!{} hacks by using #[doc = expr] where needed. by m-ou-se · Pull Request #79150 · rust-lang/rust

m-ou-se · 2020-11-17T23:04:49Z

This replaces about 200 cases of

        doc_comment! {
            concat!("The smallest value that can be represented by this integer type.

# Examples

Basic usage:

```
", $Feature, "assert_eq!(", stringify!($SelfT), "::MIN, ", stringify!($Min), ");",
$EndFeature, "
```"),
            #[stable(feature = "assoc_int_consts", since = "1.43.0")]
            pub const MIN: Self = !0 ^ ((!0 as $UnsignedT) >> 1) as Self;
        }

by

        /// The smallest value that can be represented by this integer type.
        ///
        /// # Examples
        ///
        /// Basic usage:
        ///
        /// ```
        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MIN, ", stringify!($Min), ");")]
        /// ```
        #[stable(feature = "assoc_int_consts", since = "1.43.0")]
        pub const MIN: Self = !0 ^ ((!0 as $UnsignedT) >> 1) as Self;

Note: For a usable diff, make sure to enable 'ignore whitspace': https://github.com/rust-lang/rust/pull/79150/files?diff=unified&w=1

jyn514 · 2020-11-18T05:26:56Z

This is so much nicer ❤️

m-ou-se · 2020-12-30T21:45:44Z

r? @dtolnay

library/core/src/num/int_macros.rs

jyn514 · 2020-12-30T22:01:53Z

library/core/src/num/int_macros.rs

+        /// Basic usage:
+        ///
+        /// ```
+        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX, ", stringify!($Max), ");")]


This will make #75807 so much easier ❤️

library/core/src/num/shells/int_macros.rs

jyn514 · 2020-12-30T22:38:53Z

For posterity, you can review this by adding #![doc(html_no_source)] to core/src/lib.rs, running x.py doc --stage 0 library/core, then running https://github.com/Nemo157/dotfiles/blob/master/bin/tidy-rustdoc on the output. Then you can apply the changes and diff them with diff --color=always -r core-before-tidy core-after-tidy/ | less -R

m-ou-se · 2020-12-30T22:48:40Z

Thanks for the review!

@bors r=jyn514

bors · 2020-12-30T22:48:42Z

📌 Commit 4614cdd has been approved by jyn514

…=jyn514 Remove all doc_comment!{} hacks by using #[doc = expr] where needed. This replaces about 200 cases of `````rust doc_comment! { concat!("The smallest value that can be represented by this integer type. # Examples Basic usage: ``` ", $Feature, "assert_eq!(", stringify!($SelfT), "::MIN, ", stringify!($Min), ");", $EndFeature, " ```"), #[stable(feature = "assoc_int_consts", since = "1.43.0")] pub const MIN: Self = !0 ^ ((!0 as $UnsignedT) >> 1) as Self; } ````` by ```rust /// The smallest value that can be represented by this integer type. /// /// # Examples /// /// Basic usage: /// /// ``` #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MIN, ", stringify!($Min), ");")] /// ``` #[stable(feature = "assoc_int_consts", since = "1.43.0")] pub const MIN: Self = !0 ^ ((!0 as $UnsignedT) >> 1) as Self; ``` --- **Note:** For a usable diff, make sure to enable 'ignore whitspace': https://github.com/rust-lang/rust/pull/79150/files?diff=unified&w=1

bors · 2020-12-31T06:14:48Z

⌛ Testing commit 4614cdd with merge 8b002d5...

bors · 2020-12-31T09:07:46Z

☀️ Test successful - checks-actions
Approved by: jyn514
Pushing 8b002d5 to master...

Remove unnecessary `forward_inner_docs` hack and replace it with `extended_key_value_attributes` feature. This is rust-lang#79150, but for compiler/.