[Debug] Rename DebugDescription fallback property to lldbDescription #75305
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
|
@swift-ci test |
stephentyrone
approved these changes
Jul 17, 2024
This was referenced Jul 17, 2024
|
@swift-ci test |
kastiglione
added a commit
that referenced
this pull request
Jul 25, 2024
…75289) - **Explanation**: From feedback, replace the name `_debugDescription`, which was confusing because of the underscore, with `lldbDescription`. - **Scope**: This will not break existing code. Any existing uses of `_debugDescription` would see that the debugger does not produce a summary string, but would still display all fields/children of a value. - **Original PRs**: #75305 - **Risk**: Early adopters of `_debugDescription` will not see their summary string shown. - **Testing**: Swift tests, CI. - **Reviewers**: @hborla, @stephentyrone, @DougGregor
kastiglione
deleted the
dl/main/Debug-Rename-DebugDescription-fallback-property-to-lldbDescription
branch
kastiglione
added a commit
that referenced
this pull request
Jul 30, 2024
When using `@DebugDescription`, only allow use of [LLDB Summary Strings](https://lldb.llvm.org/use/variable.html#summary-strings) syntax from `lldbDescription` properties. When `@DebugDescription` is applied to existing `debugDescription` properties, escape any `$`, as the output of `debugDescription` is never interpreted by LLDB. Depends on #75305
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.
From feedback, replace the name
_debugDescription, which was confusing because of the underscore, withlldbDescription. This new name also indicates that this property may contain LLDB Summary Strings.