Update summary for default destructuring depth #1357
Merged
Conversation
This file contains 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
nblumhardt
approved these changes
Aug 31, 2019
| /// guard against ballooning space when recursive/cyclic structures are accidentally passed. To | ||
| /// increase this limit pass a higher value. | ||
| /// change this limit pass a new maximum depth. |
2 tasks
Merged
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.
What issue does this PR address?
The summary for the
LoggerDestructuringConfiguration.ToMaximumDepthmethod incorrectly states that the default maximum destructuring depth is 5, when in fact the default is 10.There is no Issue raised for this. Since it does not change any implementation and is such a minor change I assumed it would not be necessary. Let me know if this is not the case and I'll happily add one!
Does this PR introduce a breaking change?
No. This is a documentation change only.
Please check if the PR fulfills these requirements
Other information:
As well as updating the summary, I've also added a test to confirm that the default destructuring depth of 10 is honoured.