docs: Implement transpiler documentation improvements#288
Merged
xmnlab merged 8 commits intoarxlang:mainfrom Sep 12, 2025
Merged
docs: Implement transpiler documentation improvements#288xmnlab merged 8 commits intoarxlang:mainfrom
xmnlab merged 8 commits intoarxlang:mainfrom
Conversation
xmnlab
reviewed
Sep 12, 2025
.gitignore
Outdated
| libs/astx-transpilers/dist/ | ||
| libs/astx-transpilers/build/ | ||
| libs/astx-transpilers/*.egg-info/ | ||
| libs/astx/README.md |
Contributor
There was a problem hiding this comment.
the readme files should be tracked
xmnlab
requested changes
Sep 12, 2025
.pre-commit-config.yaml
Outdated
| entry: ./scripts/build.sh | ||
| language: system | ||
| pass_filenames: false | ||
| stages: [manual] |
Contributor
There was a problem hiding this comment.
it should still be executed automatically
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR implements a comprehensive refactoring of the ASTx transpiler architecture and significantly improves the documentation (README, docs/index.md, tutorials).
📌 Key Changes
Architecture
python_to_ast.py→ Handles ASTx → Python AST object conversionpython_string.py→ Handles ASTx → Python source string generationDocumentation
README.mdwith a dedicated transpiler section and examplesdocs/index.mdto mirror README content (so GitHub and site docs stay aligned)docs/tutorials/astx_transpiler_refactor_tutorial.mdTesting
python_to_astandpython_string✅ How to Test These Changes
Run transpiler tests
python -m pytest libs/astx-transpilers/tests/test_python_to_ast.py \ libs/astx-transpilers/tests/test_python_string.py -vRun pre-commit hooks
Manual usage
Expected Output:
📂 Files Changed
README.md→ Added transpiler section with usage exampledocs/index.md→ Synced with README contentdocs/tutorials/astx_transpiler_refactor_tutorial.md→ New detailed tutorialpython_to_ast.py→ AST conversion logicpython_string.py→ Python source generation logic🌟 Benefits
📝 Author’s Checklist
🔍 Reviewer’s Checklist
main