Skip to content

Fix missing whitespace in Swift special comments #77639

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Feb 24, 2025
Merged

Fix missing whitespace in Swift special comments #77639

merged 1 commit into from
Feb 24, 2025

Conversation

honghoker
Copy link
Contributor

Hi!
I'd like to contribute with a simple fix for Swift special comments.
Fix missing whitespace in Swift special comments

Added proper spacing after // in MARK, TODO, and FIXME comments for better readability.

changes

Before

//MARK: Section
//TODO: Need to implement
//FIXME: Bug here

After

// MARK: Section
// TODO: Need to implement
// FIXME: Bug here

@honghoker
Copy link
Contributor Author

@swift-ci please test

@honghoker
Copy link
Contributor Author

@swift-ci please test

@honghoker
Copy link
Contributor Author

@swift-ci please smoke test

@honghoker
Copy link
Contributor Author

@swift-ci Please smoke test

@honghoker
Copy link
Contributor Author

@swift-ci Please test Windows platform

@AnthonyLatsis
Copy link
Collaborator

You need write access to trigger the bot.

@honghoker
Copy link
Contributor Author

@AnthonyLatsis
Oh, I really had no idea.
I misunderstood that the CI wasn't working. 😅
Thanks for letting me know.

AnthonyLatsis
AnthonyLatsis reviewed Feb 20, 2025
View reviewed changes
Copy link
Collaborator

@AnthonyLatsis AnthonyLatsis left a comment

Choose a reason for hiding this comment

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

Personally, I would prefer that TODO and FIXME lines are left alone. This cosmetic change will make it harder to git-blame them for what I believe is not a good enough reason.

@honghoker
Copy link
Contributor Author

@AnthonyLatsis I also agree. I'll go ahead and close this PR. Thank you!

@honghoker honghoker closed this Feb 20, 2025
@AnthonyLatsis
Copy link
Collaborator

AnthonyLatsis commented Feb 20, 2025 •
edited
Loading

FWIW I am fine with taking in the MARK lines. No need to open a new PR, you can just remove the other commits.

@honghoker
Copy link
Contributor Author

@AnthonyLatsis Then I'll reopen the PR so it only includes the MARK lines!

@honghoker honghoker reopened this Feb 20, 2025
@honghoker honghoker force-pushed the fix/typo branch 2 times, most recently from fc48a8d to b7f8c55 Compare February 20, 2025 12:45
AnthonyLatsis
AnthonyLatsis reviewed Feb 20, 2025
View reviewed changes
@AnthonyLatsis
Copy link
Collaborator

@swift-ci please smoke test

@honghoker
Copy link
Contributor Author

@AnthonyLatsis Though it was a minor change, I gained a valuable perspective on how it could cause confusion when checking blame. Thank you for the feedback.

@AnthonyLatsis AnthonyLatsis self-assigned this Feb 20, 2025
@AnthonyLatsis
Copy link
Collaborator

@swift-ci please smoke test Windows

@AnthonyLatsis AnthonyLatsis merged commit e0cf5a5 into swiftlang:main Feb 24, 2025
3 checks passed
@AnthonyLatsis AnthonyLatsis removed their assignment Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AnthonyLatsis AnthonyLatsis AnthonyLatsis left review comments

@Xazax-hun Xazax-hun Xazax-hun approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@honghoker @AnthonyLatsis @Xazax-hun