docs: String(buffer:) needs to mention that it will always succeed#3476
Merged
Lukasa merged 1 commit intoapple:mainfrom Jan 8, 2026
Merged
docs: String(buffer:) needs to mention that it will always succeed#3476Lukasa merged 1 commit intoapple:mainfrom
Lukasa merged 1 commit intoapple:mainfrom
Conversation
Motivation: The documentation for String(buffer:) initializer does not clearly indicate that this operation will always succeed, which may leave developers uncertain about error handling requirements. Modifications: Updated the documentation for String(buffer:) to explicitly mention that the initialization will always succeed. Result: Developers will have clearer understanding that String(buffer:) is a safe operation that does not require error handling. Signed-off-by: Karan <karanlokchandani@protonmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 documentation for String(buffer:) initializer does not clearly indicate
that this operation will always succeed, which may leave developers uncertain
about error handling requirements.
fixes: #3449
Modifications:
Updated the documentation for String(buffer:) to explicitly mention that
the initialization will always succeed.
Result:
Developers will have clearer understanding that String(buffer:) is a safe
operation that does not require error handling.