Skip to content
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

Use triple slash comments rather than block based comments #851

Merged
merged 2 commits into from
Jan 29, 2025
Merged

Use triple slash comments rather than block based comments #851

merged 2 commits into from
Jan 29, 2025

Conversation

tinder-michaelbrown
Copy link
Contributor

@tinder-michaelbrown tinder-michaelbrown commented Sep 26, 2024 •
edited
Loading

Update Nodes to use triple slash comments rather than block based comments

  • Update Nodes to use triple slash comments rather than block based comments (this matches Xcode’s documentation style using Editor -> Structure -> Add Documentation)
  • This matches the style provided with the official swift-format in Xcode 16 with the default rule of UseTripleSlashForDocumentationComments being set to true.

@tinder-michaelbrown tinder-michaelbrown self-assigned this Sep 26, 2024
@tinder-michaelbrown tinder-michaelbrown changed the title [TDP-197402] Update Nodes to use triple slash comments rather than block based comments Update Nodes to use triple slash comments rather than block based comments Nov 8, 2024
@tinder-cfuller tinder-cfuller deleted the feature/TDP-197402 branch November 14, 2024 17:41
@tinder-cfuller tinder-cfuller restored the feature/TDP-197402 branch November 15, 2024 16:37
@tinder-cfuller tinder-cfuller added the templates Templates label Nov 15, 2024
@tinder-cfuller tinder-cfuller changed the title Update Nodes to use triple slash comments rather than block based comments Use triple slash comments rather than block based comments Jan 29, 2025
@tinder-cfuller
Copy link
Collaborator

I updated the PR to leave the block based comments in the places where the comments are not documenting a type.

@tinder-cfuller tinder-cfuller merged commit ecfc533 into main Jan 29, 2025
5 checks passed
@tinder-cfuller tinder-cfuller deleted the feature/TDP-197402 branch January 29, 2025 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tinder-cfuller tinder-cfuller tinder-cfuller approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@tinder-michaelbrown @tinder-cfuller