`format_code_in_doc_comments` not applied when containing macros which takes an abstract stream of tokens
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
The following doctest has no space after the comma on line 4:
/// ```
/// use time::{macros::datetime, OffsetDateTime};
///
/// assert_eq!(datetime!(1970-01-01 00:00 UTC),OffsetDateTime::UNIX_EPOCH);
/// ```
I ran cargo fmt with the format_code_in_doc_comments option set to true to format this doctest, but this doctest was not formatted.
The expected result is:
/// ```
/// use time::{macros::datetime, OffsetDateTime};
///
-/// assert_eq!(datetime!(1970-01-01 00:00 UTC),OffsetDateTime::UNIX_EPOCH);
+/// assert_eq!(datetime!(1970-01-01 00:00 UTC), OffsetDateTime::UNIX_EPOCH);
/// ```
Note that Rust code other than doctests, such as unit tests, was formatted as expected.
#[cfg(test)]
mod tests {
use time::{macros::datetime, OffsetDateTime};
use super::*;
#[test]
fn it_works() {
assert_eq!(datetime!(1970-01-01 00:00 UTC),OffsetDateTime::UNIX_EPOCH);
}
}
The above unit test was formatted as expected as follows:
#[cfg(test)]
mod tests {
use time::{macros::datetime, OffsetDateTime};
use super::*;
#[test]
fn it_works() {
assert_eq!(datetime!(1970-01-01 00:00 UTC), OffsetDateTime::UNIX_EPOCH);
}
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the doctest with cargo fmt and format_code_in_doc_comments enabled, then compare it with the unit-test example that formats correctly. Trace how rustfmt handles doc comments containing the datetime! macro and identify where formatting stops; done means the doctest gains the expected space after the comma without changing other code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100