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
Architecture overview #2528
Architecture overview #2528
Conversation
|
Wouldn't this be a suitable document to be placed on the rustpython web page? The docs repo looks like it would be good candidate. |
|
@DimitrisJim I agree. Would you please review it? |
architecture/architecture.md
Outdated
| Some things to note: | ||
|
|
||
| - The CLI is defined in `src/lib.rs@run` | ||
| - The interface and helper for the REPL are defined in this package, but the actual REPL can be found in `vm/rustyline.rs` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's vm/src/readline.rs (now, at least).
c038228
to
36db236
Compare
…t in top level readme.
36db236
to
f95d73f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
finally got to this 😄 I think this does offer value in this repo, thanks (very belatedly!) for the PR!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few nitpicks, mostly non-blocking.
|
|
||
| A high-level overview of the workings of RustPython is visible in the figure below, showing how Python source files are interpreted. | ||
|
|
||
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might want to consider rewriting this diagram in Mermaid.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's wild. +1 but can probably leave this for a later point.
Co-authored-by: fanninpm <fanninpm@miamioh.edu>
Adds the architecture document as proposed by #2524.
This PR serves as a place for discussion regarding updates, suggestions and improvements 😃.