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

Document round trip ability #1052

Merged
merged 3 commits into from
Nov 27, 2023
Merged

Document round trip ability #1052

merged 3 commits into from
Nov 27, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Nov 27, 2023

Rationale

The property that the crate attempts to preserve "round trip ability" has come up in several PRs, most recently with @takluyver last week

Changes

  1. Document the desired ability to round trip SQL in readme
  2. add doc examples
  3. add hints in parse_sql_statements that the verified* variants should be prefered

There are no code changes in this PR

@coveralls
Copy link

coveralls commented Nov 27, 2023

Pull Request Test Coverage Report for Build 7008526520

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
To ensure accuracy in future PRs, please see these guidelines.
A quick fix for this PR: rebase it; your next report should be accurate.

  • 0 of 10 (0.0%) changed or added relevant lines in 1 file are covered.
  • 378 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.04%) to 87.71%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/lib.rs 0 10 0.0%
Files with Coverage Reduction New Missed Lines %
src/ast/query.rs 55 83.81%
src/ast/visitor.rs 56 0.0%
src/lib.rs 267 11.92%
Totals Coverage Status
Change from base Build 6961241850: -0.04%
Covered Lines: 17992
Relevant Lines: 20513

💛 - Coveralls

@alamb alamb requested review from Dandandan and andygrove November 27, 2023 17:11
@alamb
Copy link
Contributor Author

alamb commented Nov 27, 2023

Do you have any comments about this @Dandandan / @andygrove ?

@alamb
Copy link
Contributor Author

alamb commented Nov 27, 2023

Thank you @andygrove

@alamb alamb merged commit 64eccdb into apache:main Nov 27, 2023
@alamb alamb deleted the alamb/docs2 branch November 27, 2023 17:30
@takluyver
Copy link
Contributor

Should comments be mentioned as another exception? In my brief test, comments didn't seem to be present in the AST (and I wouldn't particularly expect them) - but maybe that's planned, or there's an option I've overlooked.

@alamb
Copy link
Contributor Author

alamb commented Nov 30, 2023

Should comments be mentioned as another exception? In my brief test, comments didn't seem to be present in the AST (and I wouldn't particularly expect them) - but maybe that's planned, or there's an option I've overlooked.

I agree comments should be another exception

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants