Use a real newline when wrapping quantiles under the title - #341
Open
uttam12331 wants to merge 1 commit into
Open
Use a real newline when wrapping quantiles under the title#341uttam12331 wants to merge 1 commit into
uttam12331 wants to merge 1 commit into
Conversation
`wrap_title_quantiles=True` built the title with "{0} =\n{1}", where the
escaped backslash makes "\n" a literal two-character sequence rather than a
newline, so the quantile summary was never placed on a separate line as the
parameter's docstring promises -- instead a literal "\n" appeared in the
title text.
Use "{0} =\n{1}" so the summary wraps onto a new line, and add a regression
test asserting the title contains a real newline only when wrapping is on.
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
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.
Summary
The
wrap_title_quantiles=Trueoption is supposed to place the quantile summary on a separate line below the parameter name (per its docstring). But the title is built with an escaped backslash:In a normal (non-raw) string,
"\n"is a literal backslash followed byn, not a newline. So the feature never wraps — it injects the visible characters\ninto the title.Reproduction
Fix
Tests
Added
test_wrap_title_quantiles, which asserts a title contains a real newline whenwrap_title_quantiles=Trueand none when it'sFalse. It fails on the current code (literal\n, no newline character) and passes with the fix.