Maintenance guide #24
Open
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
…DO and example code to suggesteed changes
alancai98
reviewed
Aug 7, 2025
| } | ||
| ``` | ||
|
|
||
| 4. **Test the visualization**: Create a test query that uses the new node type and verify that it renders correctly. |
There was a problem hiding this comment.
Should also include a reference for where to put the test and how to work w/ the snapshot testing
LIBRARY_GUIDE.md
Outdated
|
|
||
| 4. **Test with complex queries**: Verify that visualizations work correctly with complex, nested queries. | ||
|
|
||
| 5. **Consider performance**: For very large ASTs, consider optimizations to improve rendering speed. |
There was a problem hiding this comment.
This is probably too vague for a suggestion. Think we can just opt to remove it.
LIBRARY_GUIDE.md
Outdated
|
|
||
| ### Utility Functions | ||
|
|
||
| - **`escapeGraphvizLabel(String text)`**: Escapes special characters in labels. |
There was a problem hiding this comment.
nit: can provide some rationale that graphviz labels need to escape special characters
alancai98
reviewed
Aug 7, 2025
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
out of scope for this PR but this file from the other unmerged PR is included. a couple ways to fix
- create a different branch with just the
LIBRARY_GUIDE.mdfile or - set the target branch for this PR to the other PR's branch (this will eliminate the redundant commits)
…nal for escape characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Issue #, if available:
none
Description of changes:
Created Library Guide for Graphviz-PartiQL-Lang
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.