QuotedString: Add caution about param interactions #606
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
As implemented in `QuotedString`, `convert_whitespace_escapes` has no effect unless `unquote_results` is set to `True`. Add a Caution admonition to the API documentation, advising of this restriction.
3f71c0e to
3954643
Compare
|
Thanks for digging in to this. Will push out in a point release this month. |
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.
Looking at adjusting the pydot GraphViz parser's handling of quoted strings, I was rather surprised to discover an unexpected interaction in the
QuotedStringparameters:As implemented in
QuotedString,convert_whitespace_escapeshas no effect unlessunquote_resultsis set toTrue.This PR adds a Caution admonition to the API documentation, advising users of this restriction.