@@ -10,8 +10,12 @@ The goal of code.ast is to combine the efficiency and variety of languages suppo
1010
1111To achieve this, code.ast adds the features:
12121 . ** Auto-loading:** Compile of source code parsers for any language supported by tree-sitter with a single keyword,
13- 2 . ** Visitors:** Search the AST quickly,
14- 3 . ** Transformers:** Transform source code easily by transforming the AST structure
13+ 2 . ** Visitors:** Search the concrete syntax tree produced by tree-sitter quickly,
14+ 3 . ** Transformers:** Transform source code easily by transforming the syntax structure
15+
16+ * Note* that tree-sitter produces a concrete syntax tree and we currently parse
17+ the CST as is. Future versions of code.ast might include options to simplify the CST
18+ to an AST.
1519
1620## Installation
1721The package is tested under Python 3. It can be installed via:
@@ -70,7 +74,7 @@ lang = "java")
7074```
7175
7276## Visitors
73- code.ast implements the visitor pattern to quickly traverse the AST structure:
77+ code.ast implements the visitor pattern to quickly traverse the CST structure:
7478``` python
7579import code_ast
7680from code_ast import ASTVisitor
@@ -152,7 +156,7 @@ mirror_transformer.code()
152156## Project Info
153157The goal of this project is to provide developer in the
154158programming language processing community with easy
155- access to AST parsing. This is currently developed as a helper library for internal research projects. Therefore, it will only be updated
159+ access to syntax parsing. This is currently developed as a helper library for internal research projects. Therefore, it will only be updated
156160as needed.
157161
158162Feel free to open an issue if anything unexpected
0 commit comments