Auto-format README.md #341
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
@bachand, this fixed this markdown rendering issue in some Before 
After 
|
bachand
approved these changes
Dec 4, 2025
README.md
Outdated
| @@ -527,7 +530,7 @@ _You can enable the following settings in Xcode by running [this script](resourc | |||
|
|
|||
| </details> | |||
|
|
|||
| * <a id='trailing-commas'></a>(<a href='#trailing-commas'>link</a>) **Add a trailing comma after the last element of multi-line, multi-element comma-separated lists.* This includes arrays, dictionaries, function declarations, function calls, etc. Don't include a trailing comma if the list spans only a single line, or contains only a single element. [](https://github.com/nicklockwood/SwiftFormat/blob/main/Rules.md#trailingCommas) | |||
| - <a id='trailing-commas'></a>(<a href='#trailing-commas'>link</a>) \*_Add a trailing comma after the last element of multi-line, multi-element comma-separated lists._ This includes arrays, dictionaries, function declarations, function calls, etc. Don't include a trailing comma if the list spans only a single line, or contains only a single element. [](https://github.com/nicklockwood/SwiftFormat/blob/main/Rules.md#trailingCommas) | |||
Contributor
There was a problem hiding this comment.
Suggested change
| - <a id='trailing-commas'></a>(<a href='#trailing-commas'>link</a>) \*_Add a trailing comma after the last element of multi-line, multi-element comma-separated lists._ This includes arrays, dictionaries, function declarations, function calls, etc. Don't include a trailing comma if the list spans only a single line, or contains only a single element. [](https://github.com/nicklockwood/SwiftFormat/blob/main/Rules.md#trailingCommas) | |
| - <a id='trailing-commas'></a>(<a href='#trailing-commas'>link</a>) **Add a trailing comma after the last element of multi-line, multi-element comma-separated lists.** This includes arrays, dictionaries, function declarations, function calls, etc. Don't include a trailing comma if the list spans only a single line, or contains only a single element. [](https://github.com/nicklockwood/SwiftFormat/blob/main/Rules.md#trailingCommas) |
I think that this better matches the intention.
Member
Author
There was a problem hiding this comment.
Oh yeah thanks for catching, this was broken from the missing trailing *
| @@ -3381,7 +3397,6 @@ _You can enable the following settings in Xcode by running [this script](resourc | |||
| Most classes are never overridden, and composition is generally preferred over inheritance. | |||
|
|
|||
| If a class does need to be subclassed, use one of these approaches to indicate to the linter that the class should not be marked `final`: | |||
|
|
|||
| - uses: ruby/setup-ruby@v1 | ||
| with: | ||
| bundler-cache: true | ||
| - uses: actions/setup-node@v4 |
calda
force-pushed
the
cal--format-markdown
branch
from
5a3a66b to
57aadef
Compare
calda
force-pushed
the
cal--format-markdown
branch
from
7ee1b26 to
7fb972a
Compare
bachand
reviewed
Dec 5, 2025
| - <a id='unused-function-parameter-naming'></a>(<a href='#unused-function-parameter-naming'>link</a>) **Name unused function parameters as underscores (`_`).** | ||
|
|
||
| <details> | ||
| <details> |
Contributor
There was a problem hiding this comment.
@calda do you have a sense of why some of these details tags were indented further than others? I am asking to learn.
Member
Author
There was a problem hiding this comment.
I figure it was unintentional
|
|
||
| _Exception: You may prefix a private property with an underscore if it is backing an identically-named property or method with a higher access level._ | ||
|
|
||
| <details> |
| </details> | ||
|
|
||
| - <a id='trailing-commas'></a>(<a href='#trailing-commas'>link</a>) \*_Add a trailing comma after the last element of multi-line, multi-element comma-separated lists._ This includes arrays, dictionaries, function declarations, function calls, etc. Don't include a trailing comma if the list spans only a single line, or contains only a single element. | ||
| - <a id='trailing-commas'></a>(<a href='#trailing-commas'>link</a>) **Add a trailing comma after the last element of multi-line, multi-element comma-separated lists.** This includes arrays, dictionaries, function declarations, function calls, etc. Don't include a trailing comma if the list spans only a single line, or contains only a single element. |
README.md
Outdated
|
|
||
| </details> | ||
|
|
||
| - <a id='long-typealias'></a>(<a href='#long-typealias'>link</a>) [Long](https://github.com/airbnb/swift#column-width) type aliases of protocol compositions should wrap before the `=` and before each individual `&`. |
README.md
Outdated
|
|
||
| </details> | ||
|
|
||
| - <a id='url-macro'></a>(<a href='#url-macro'>link</a>) **If available in your project, prefer using a `#URL(_:)` macro instead of force-unwrapping `URL(string:)!` initializer`**. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired by #339, this PR adds linting and auto-formatting for our
README.md.I couldn't find a good Markdown auto-formatter in the Ruby ecosystem. Claude suggested using
prettiervianpx. This adds a dependency on Node, but at least installing Node is really easy (brew install node).The changes all seem like great improvements.