Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose extra options to control string escaping in dot file generation #1230

Open
mtreinish opened this issue Jun 28, 2024 · 0 comments
Open
Labels
enhancement New feature or request
Milestone

Comments

@mtreinish
Copy link
Member

What is the expected enhancement?

The dot syntax can be a bit particular about character escaping and quotation marks. For example as was previously reported in #750. This was attempted to be fixed in #1203 by escaping special characters in the string and wrapping everything in quotation marks. However, this solution was a bit overeager in it's application as existing users were relying on low level control of inserting quotation marks or not to generate dot files in their usage of the dot file generation, so this was reverted in #1229. However, this is a clear argument for doing that string escaping so users don't have to worry about it. I think we should expand the interface on .to_dot() and graphviz_draw() to expose options to control how we escape strings or autowrap them in quotes. At the very least we should document the current assumptions around how the function behaves.

@mtreinish mtreinish added the enhancement New feature or request label Jun 28, 2024
@mtreinish mtreinish added this to the 0.16.0 milestone Jun 28, 2024
@IvanIsCoding IvanIsCoding modified the milestones: 0.16.0, 0.17.0 Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants