Skip to content

Commit 2867670

Browse files
committed
Update architecture documentation for ruff_python_parser
RustPython now uses ruff_python_parser from astral-sh/ruff instead of the separate RustPython/Parser project. Update architecture documentation to reflect this change.
1 parent 2112b93 commit 2867670

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

architecture/architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The main entry point of RustPython is located in `src/main.rs` and simply forwar
7272

7373
For each of the three components, the entry point is as follows:
7474

75-
- Parser: The Parser is located in a separate project, [RustPython/Parser][10]. See the documentation there for more information.
75+
- Parser: The Parser is located in a separate project, [astral-sh/ruff/crates/ruff_python_parser][10]. See the documentation there for more information.
7676
- Compiler: `compile`, located in [`crates/vm/src/vm/compile.rs`][11], this eventually forwards a call to [`compiler::compile`][12].
7777
- VM: `run_code_obj`, located in [`crates/vm/src/vm/mod.rs`][13]. This creates a new frame in which the bytecode is executed.
7878

@@ -107,7 +107,7 @@ The Parser is the main sub-component of the compiler. All the functionality requ
107107
1. Lexical Analysis
108108
2. Parsing
109109

110-
The functionality for parsing resides in the RustPython/Parser project. See the documentation there for more information.
110+
The functionality for parsing resides in the ruff_python_parser project in the astral-sh/ruff repository. See the documentation there for more information.
111111

112112
### VM
113113

@@ -177,7 +177,7 @@ Integration and snippets that test for additional edge-cases, implementation spe
177177
[7]: https://github.com/RustPython/RustPython/blob/main/DEVELOPMENT.md
178178
[8]: https://rustpython.github.io/guideline/2020/04/04/how-to-contribute-by-cpython-unittest.html
179179
[9]: https://github.com/RustPython/RustPython/blob/d36a2cffdef2218f3264cef9145a1f781d474ea3/src/lib.rs#L72
180-
[10]: https://github.com/RustPython/Parser
180+
[10]: https://github.com/astral-sh/ruff/tree/2bffef59665ce7d2630dfd72ee99846663660db8/crates/ruff_python_parser
181181
[11]: https://github.com/RustPython/RustPython/blob/d36a2cffdef2218f3264cef9145a1f781d474ea3/crates/vm/src/vm/compile.rs#L10
182182
[12]: https://github.com/RustPython/RustPython/blob/d36a2cffdef2218f3264cef9145a1f781d474ea3/crates/vm/src/vm/compile.rs#L26
183183
[13]: https://github.com/RustPython/RustPython/blob/d36a2cffdef2218f3264cef9145a1f781d474ea3/crates/vm/src/vm/mod.rs#L433

0 commit comments

Comments
 (0)