This pull request has merge conflicts. Could you please resolve them @umgefahren? 🙏

1. Add file named rustfmt.toml to project root
2. Fill it with the following:

   unstable_features = true
   format_code_in_doc_comments = true

Unstable options are unavailable on stable Rust, right? You can hack around that by passing the options via the commandline last time I checked :)

We could do the same thing as we do for clippy and make a cargo alias for formatting.

See here for example: https://github.com/Restioson/xtra/blob/master/.cargo/config.toml

1. Add file named rustfmt.toml to project root
2. Fill it with the following:

   unstable_features = true
   format_code_in_doc_comments = true

Unstable options are unavailable on stable Rust, right? You can hack around that by passing the options via the commandline last time I checked :)

We could do the same thing as we do for clippy and make a cargo alias for formatting.

See here for example: https://github.com/Restioson/xtra/blob/master/.cargo/config.toml

That"s a good idea. I was looking for passing with options and probably overlooked it. I will add a custom cargo fmt command alias. Although it should be noted that this feature is not bug-free. Last time I looked it could case an ICE on empty doc comment code blocks.

This pull request has merge conflicts. Could you please resolve them @umgefahren? 🙏

That"s a good idea. I was looking for passing with options and probably overlooked it. I will add a custom cargo fmt command alias. Although it should be noted that this feature is not bug-free. Last time I looked it could case an ICE on empty doc comment code blocks.

That is not ideal but I don"t think it is a big issue. We can go back to regular rustfmt if it ever causes problems.

It would be good to get some more opinions on this though. cc @libp2p/rust-libp2p-maintainers

fmt -- --config format_code_in_doc_comments=true

I think it makes sense! Can we also stage the rustfmt.toml so when we cargo fmt it runs with such options?

fmt -- --config format_code_in_doc_comments=true

I think it makes sense! Can we also stage the rustfmt.toml so when we cargo fmt it runs with such options?

We could, but it would be a bit inconsistent with how we do things in this repo. Since we could could configure clippy via clippy.toml as well. But not a strong opinion.

fmt -- --config format_code_in_doc_comments=true

I think it makes sense! Can we also stage the rustfmt.toml so when we cargo fmt it runs with such options?

We could, but it would be a bit inconsistent with how we do things in this repo. Since we could could configure clippy via clippy.toml as well. But not a strong opinion.

Configuring clippy lints via a config file is unimplemented so we can"t use it.

Activating unstable fmt options on stable Rust also doesn"t work so we can"t use it :)