Document new VarCloner::setMinDepth function #8155
Merged
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
89dd756 to
32ca116
Compare
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Jul 17, 2017
…ston-thumbtack) This PR was merged into the 3.4 branch. Discussion ---------- [VarDumper] Added setMinDepth to VarCloner This new function allows VarCloner users to specify a minimum tree depth that must be fully explored before we start limiting the number of cloned items via the existing setMaxItems functionality. It’s useful for dumping arguments from a backtrace to ensure some minimum level of detail, while keeping a very low setMaxItems value to ensure fast performance at the deeper levels. | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | yes <!-- don't forget updating src/**/CHANGELOG.md files --> | BC breaks? | no | Deprecations? | no <!-- don't forget updating UPGRADE-*.md files --> | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | symfony/symfony-docs#8155 <!--highly recommended for new features--> <!-- - Bug fixes must be submitted against the lowest branch where they apply (lowest branches are regularly merged to upper ones so they get the fixes too). - Features and deprecations must be submitted against the 3.4, legacy code removals go to the master branch. - Please fill in this template according to the PR you're about to submit. - Replace this comment by a description of what your PR is solving. --> Commits ------- d6534f5 [VarDumper] Added setMinDepth to VarCloner
|
The actual code has been merged, so this PR is also ready for review and subsequent merging now. |
HeahDude
reviewed
Jul 29, 2017
| algorithm so that lower level items have higher priority than deeply nested | ||
| items; | ||
| items. Specifying ``-1`` removes the limit. |
There was a problem hiding this comment.
This paragraph changes should target 3.2 right?
There was a problem hiding this comment.
This paragraph still accurately describes behavior of older versions. For versions < 3.4 we can assume the minimum nesting depth is hard-coded to 1; this is indicated by the next paragraph that says "The default value is 1, which is consistent with older Symfony versions." The presence of setMaxItems is much older than v3.2 - it goes back to Symfony 2 (maybe back to the original introduction of VarCloner).
javiereguiluz
approved these changes
Jan 31, 2018
HeahDude
approved these changes
Jan 31, 2018
|
James, thanks for your contribution! I'm sorry it took us so long to merge it ... but it's finally merged! |
javiereguiluz
added a commit
that referenced
this pull request
Feb 1, 2018
…ton-thumbtack) This PR was merged into the 3.4 branch. Discussion ---------- Document new VarCloner::setMinDepth function Documentation for new ``setMinDepth`` function in the VarDumper component's cloner. (This function is pending code review / merge.) Commits ------- 32ca116 Document new VarCloner::setMinDepth function
|
Well, better late than never. :) |
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.
Documentation for new
setMinDepthfunction in the VarDumper component's cloner. (This function is pending code review / merge.)