Skip to content

Fix date-check comment formatting #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 21, 2021
Merged

Conversation

camelid
Copy link
Member

@camelid camelid commented Feb 21, 2021

Fix date-check comment formatting

I realized that the format I had been previously using for date-checks

(as of January 2021 <!-- date: 2021-01 -->)

left a space before the closing parenthesis in the rendered output,
which looks weird.

I could fix this by removing the space between 2021 and <!-- ...,
but that looks weird in the source. So I ended up deciding on changing
it to

(as of <!-- date: 2021-01 --> January 2021)

@camelid camelid added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Feb 21, 2021
I realized that the format I had been previously using for date-checks

    (as of January 2021 <!-- date: 2021-01 -->)

left a space before the closing parenthesis in the rendered output,
which looks weird.

I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to

    (as of <!-- date: 2021-01 --> January 2021)
Copy link
Member

@JohnTitor JohnTitor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable to me 👍

@camelid camelid merged commit 5297659 into rust-lang:master Feb 21, 2021
@camelid camelid deleted the date-ref-fmt branch February 21, 2021 03:24
camelid added a commit to camelid/rustc-dev-guide that referenced this pull request Feb 21, 2021
It turns out I missed several in rust-lang#1066.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants