Add a debugDescription for TypeInfo for use when logging#12
Merged
Conversation
2 tasks
ianpartridge
approved these changes
Sep 25, 2018
Contributor
ianpartridge
left a comment
There was a problem hiding this comment.
Fine - I think new conformances are SemVer minor?
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.
The
descriptionproperty forTypeInfoproduces a human-readable representation of the structured type information, which includes recursing into nested types.When a TypeInfo enum is used in a log message, the output can be overly verbose. In my scenario, I want to be able to identify the case and associated top-level type for the purposes of debugging.
This PR defines a more compact representation in the
debugDescription(viaCustomDebugStringConvertible) which describes the case that a TypeInfo represents, and its immediate associated types (but no more). An exception is.dynamicKeyed, whose description is already suitably succinct.