Skip to content

Use triple slash comments rather than block based comments#851

Merged
tinder-cfuller merged 2 commits intomainfrom
feature/TDP-197402
Jan 29, 2025
Merged

Use triple slash comments rather than block based comments#851
tinder-cfuller merged 2 commits intomainfrom
feature/TDP-197402

Conversation

@michaelbrown-info
Copy link
Contributor

@michaelbrown-info michaelbrown-info commented Sep 26, 2024

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.

@michaelbrown-info michaelbrown-info self-assigned this Sep 26, 2024
@michaelbrown-info michaelbrown-info 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

Labels

templates Templates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants