Skip to content

Commit d931ffe

Browse files
committed
Update README.md
1 parent 23c4922 commit d931ffe

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,18 @@ similar semantics are represented with the same AST. We welcome PRs to fix such
100100
issues and distinguish different syntaxes in the AST.
101101

102102

103-
## WIP: Extracting source locations from AST nodes
103+
## Source Locations (Work in Progress)
104104

105-
This crate allows recovering source locations from AST nodes via the [Spanned](https://docs.rs/sqlparser/latest/sqlparser/ast/trait.Spanned.html) trait, which can be used for advanced diagnostics tooling. Note that this feature is a work in progress and many nodes report missing or inaccurate spans. Please see [this document](./docs/source_spans.md#source-span-contributing-guidelines) for information on how to contribute missing improvements.
105+
This crate allows recovering source locations from AST nodes via the [Spanned]
106+
trait, which can be used for advanced diagnostics tooling. Note that this
107+
feature is a work in progress and many nodes report missing or inaccurate spans.
108+
Please see [this document] for information on how to contribute missing
109+
improvements.
106110

107-
```rust
108-
use sqlparser::ast::Spanned;
111+
[Spanned]: https://docs.rs/sqlparser/latest/sqlparser/ast/trait.Spanned.html
112+
[this document]: ./docs/source_spans.md#source-span-contributing-guidelines
109113

114+
```rust
110115
// Parse SQL
111116
let ast = Parser::parse_sql(&GenericDialect, "SELECT A FROM B").unwrap();
112117

0 commit comments

Comments
 (0)