Update non_optional_string_data_conversion rule docs and examples to make it more clear #6088
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
Here's an example of your CHANGELOG entry: * Update non_optional_string_data_conversion rule docs and examples to make it more clear.
[SergeyPekar](https://github.com/SergeyPekar)
[#issue_number](https://github.com/realm/SwiftLint/issues/issue_number)note: There are two invisible spaces after the entry's text. Generated by 🚫 Danger |
SimplyDanny
requested changes
Jun 5, 2025
Yes. Looks like it was a bug of 0.55.1 (see the screenshot) that is already fixed |
SimplyDanny
reviewed
Jun 15, 2025
| name: "Non-optional String -> Data Conversion", | ||
| description: "Prefer non-optional `Data(_:)` initializer when converting `String` to `Data`", | ||
| name: "Non-optional String <-> Data Conversion", | ||
| description: "Prefer the non-optional initializers when converting between `String` and `Data` (e.g. `Data(_:)` and `String(decoding:as:)`)", |
There was a problem hiding this comment.
If you are still interested in providing extended documentation for this rule, please let the description property as it is and prefer the optional rationale property. It serves exactly this purpose.
|
@SergeyPekar: Do you still fancy to add more documentation? If not, please close the PR at will. |
I will take a look during the week and close the PR if I won't come up with anything fancy |
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.
Motivation:
The rule
non_optional_string_data_conversionis bidirectional it is triggered when converting string to data as well as when converting from data to string so this behaviour is needed to be clearly documented.Changes: