Skip to content

Commit e027b3c

Browse files
authored
Document that comments aren't preserved for round trip (apache#1060)
1 parent da2296e commit e027b3c

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ analysis, feel free to use this project as a base.
6161

6262
## Preserves Syntax Round Trip
6363

64-
This crate allows users to recover the original SQL text (with normalized
65-
whitespace and keyword capitalization), which is useful for tools that
66-
analyze and manipulate SQL.
64+
This crate allows users to recover the original SQL text (with comments removed,
65+
normalized whitespace and keyword capitalization), which is useful for tools
66+
that analyze and manipulate SQL.
6767

68-
This means that other than whitespace and the capitalization of keywords, the
69-
following should hold true for all SQL:
68+
This means that other than comments, whitespace and the capitalization of
69+
keywords, the following should hold true for all SQL:
7070

7171
```rust
7272
// Parse SQL

src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@
4141
//!
4242
//! # Creating SQL text from AST
4343
//!
44-
//! This crate allows users to recover the original SQL text (with normalized
45-
//! whitespace and identifier capitalization), which is useful for tools that
46-
//! analyze and manipulate SQL.
44+
//! This crate allows users to recover the original SQL text (with comments
45+
//! removed, normalized whitespace and identifier capitalization), which is
46+
//! useful for tools that analyze and manipulate SQL.
4747
//!
4848
//! ```
4949
//! # use sqlparser::dialect::GenericDialect;

0 commit comments

Comments
 (0)